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

RichEditCommands.setParagraphLevel Property

Gets a command to apply a paragraph level to the selected text

Declaration

readonly setParagraphLevel: SetParagraphLevelCommand

Property Value

Type Description
SetParagraphLevelCommand

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

The setParagraphLevel method allows you to control whether the selected paragraphs are displayed in a table of contents depending on the level parameter's value:

  • 0 - the selected paragraphs are not shown in the table of contents;
  • 1 - 9 - the selected paragraphs are shown in the table of contents on the corresponding level.

Usage example:


richEdit.commands.setParagraphLevel.execute(2);

You can use the getState method to obtain the selected paragraphs' current paragraph level.

See Also