ASPxClientCommandConsts.FORMATDOCUMENT_COMMAND Property

Identifies a command that formats the current HTML document.

Declaration

static FORMATDOCUMENT_COMMAND: string

Property Value

Type	Description
string	Value: “formatdocument”

Remarks

The FORMATDOCUMENT_COMMAND property can be used in the following ways.

• In the ASPxClientHtmlEditor.CommandExecuted event — to determine the action performed by an end-user. If the ASPxClientHtmlEditorCommandEventArgs.commandName event parameter returns the FORMATDOCUMENT_COMMAND property value, this means that the Format Document context menu item was clicked by an end-user.
• In the ASPxClientHtmlEditor.ExecuteCommand method — to execute the command manually.

The following example illustrates how to use the FORMATDOCUMENT_COMMAND property.

ASPX

<dx:ASPxHtmlEditor runat="server" ID="ASPxHtmlEditor2">
    <ClientSideEvents Init="ensureDocumentFormat" ActiveTabChanged="ensureDocumentFormat" />
</dx:ASPxHtmlEditor>

JS

<script>
function ensureDocumentFormat(s, e) {
    if(s.GetActiveTabName() == "HTML")
        s.ExecuteCommand(ASPxClientCommandConsts.FORMATDOCUMENT_COMMAND);
    }
</script>

Note

This command is available only in the HTML View.