ChangePageColorCommand.execute(color) Method

Executes the ChangePageColorCommand command with the specified parameter.

Declaration

execute(
    color: string
): boolean

Parameters

Name Type Description
color string

A string specifying a background color of all pages contained in the document. May be specified as a color name or a hex color value.

Returns

Type Description
boolean

true if the command has been successfully executed; false if the command execution has failed.

Remarks

Usage example:

richEdit.commands.changePageColor.execute("red");
richEdit.commands.changePageColor.execute("#FF0000");
See Also