RichEditCommands.insertTableOfFigures Property

Gets a command to create a table of figures on the base of figures captions.

Declaration

get insertTableOfFigures(): InsertTableOfFiguresCommand

Property Value

Type	Description
InsertTableOfFiguresCommand	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.

The 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:

JS

richEdit.commands.insertTableOfFigures.execute();

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