cut

RichEditCommands.goToHeader Property

Gets a command to substitute a footer sub-document with a header sub-document of the same page as an active sub-document.

Declaration

readonly goToHeader: GoToHeaderCommand

Property Value

Type Description
GoToHeaderCommand

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.


richEdit.commands.goToHeader.execute();

If the header sub-document does not exist for the current page, the command creates it.

The active sub-document is available via the RichEditDocument.activeSubDocument property.

See Also