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

RichEditCommands.insertFiguresCaption Property

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

Declaration

readonly insertFiguresCaption: InsertFiguresCaptionCommand

Property Value

Type Description
InsertFiguresCaptionCommand

A InsertFiguresCaptionCommand 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 InsertFiguresCaptionCommand class.

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

Usage example:


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