InsertFiguresCaptionCommand.execute Method
Executes the InsertFiguresCaptionCommand 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(): boolean
Returns
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.
This command adds the “Figure {SEQ Figure }“ text at the current position in the document.
Usage example
richEdit.commands.insertFiguresCaption.execute();
See Also