InsertTableOfFiguresCommand.execute Method
Executes the InsertTableOfFiguresCommand command by imitating the corresponding end-user action made in the RichEdit’s UI.
May result in taking no action if the command’s state does not allow command execution. Use the object’s getState method to check the command state.
Declaration
execute(): booleanReturns
| Type | Description |
|---|---|
| boolean | A Boolean value identifying whether method execution was successful or failed. |
Remarks
The execute method checks the command state (obtained using the getState method) before executing, and decides whether the action can be performed.
The RichEditCommands.insertTableOfFigures command generates a table based on numbered labels, which have been added to figures via RichEditCommands.insertFiguresCaption.
This command adds the { TOC \h \c “Figure”} field code at the current position in the document.
Usage example:
richEdit.commands.InsertTableOfFigures.execute();