tblmodelprompthook
tblmodelprompthook
Function prototype:
ret = hook (tmIDs[])
Synopsis
Use with:
add_hook(hookname, func[, prepend])
remove_hook(hookname, func)
where hookname is tblmodelprompthook.
If the current document type supports multiple table models, the tblmodelprompthook function is called when a user inserts a table and the cursor is in a location in which it is valid to insert more than one table model. This hook lets users choose the table model they want to insert.
Arguments
tmIDs is an array of valid table model IDs.
Return Arguments
• -1 — Cancels the table insertion.
• 0 — Displays the prompt if
set prompttablemodels is
on, or automatically inserts the primary table model if
set prompttablemodel is
off.
• Non-zero integer — A one-based index value into the tmIDs array that indicates the table model to be inserted.
Related Topics