ASPxClientCommandConsts.CUSTOMDIALOG_COMMAND Property
In This Article
Identifies a command that invokes a custom dialog.
#Declaration
TypeScript
static CUSTOMDIALOG_COMMAND: string
#Property Value
Type | Description |
---|---|
string | Value: “customdialog” |
#Remarks
The CUSTOMDIALOG_COMMAND property can be used in the following ways.
- In the ASPxClientHtmlEditor.CommandExecuted event — to determine the toolbar or ribbon item clicked by an end-user. If the ASPxClientHtmlEditorCommandEventArgs.commandName event parameter returns the CUSTOMDIALOG_COMMAND property value, this means that either the ToolbarCustomDialogButton toolbar item or the HECustomDialogRibbonCommand ribbon item (depending upon the toolbar mode used) has been manipulated by an end-user.
In the ASPxClientHtmlEditor.ExecuteCommand method — to execute the command manually.
In this case, the method requires an additional parameter, which is a string representing the name of the custom dialog to be invoked.
// invokes the "MyDialog" custom dialog htmlEditor.ExecuteCommand(ASPxClientCommandConsts.CUSTOMDIALOG_COMMAND, 'MyDialog');
Note
This command is available only in the Design View.
See Also