RichEditCommands.insertFiguresCaption Property

Gets a command to add a caption (numbered label) to a figure.

Declaration

get insertFiguresCaption(): InsertFiguresCaptionCommand

Property Value

Type	Description
InsertFiguresCaptionCommand	An object that provides methods that execute the command and check its state.

Remarks

Call the execute method to invoke the command. The method checks the command state (obtained via the getState method) to determine whether the action can be performed.

This command adds the “Figure {SEQ Figure }“ text at the current position in the document.

Usage example:

JS

richEdit.commands.insertFiguresCaption.execute();

Refer to the following section for more information: Client Commands.