Skip to main content
cut

RichEditCommands.goToFooter Property

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

#Declaration

TypeScript
get goToFooter(): GoToFooterCommand

#Property Value

Type Description
GoToFooterCommand

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.goToFooter.execute();

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

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

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

See Also