The requested page is not available for the requested platform. You are viewing the content for Default platform.
cut

RichEditCommands.insertTableOfFigures Property

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

Declaration

readonly insertTableOfFigures: InsertTableOfFiguresCommand

Property Value

Type Description
InsertTableOfFiguresCommand

A InsertTableOfFiguresCommand object that provides methods for executing the command and checking its state.

Remarks

You can invoke this command by calling the execute method.

The execute method checks the command state (obtained using the getState method) before executing, and decides whether the action can be performed. The execute and getState methods are members of the InsertTableOfFiguresCommand class.

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:


richEdit.commands.insertTableOfFigures.execute();
See Also