The requested page is not available for the requested platform. You are viewing the content for Default platform.

ASPxClientCommandConsts.INSERTLINK_COMMAND Property

Identifies a command that inserts a new hyperlink.

Declaration

static INSERTLINK_COMMAND: string

Property Value

Type Description
string

Value: "insertlink"

Remarks

The INSERTLINK_COMMAND property can be used in the followng ways.

  • In the ASPxClientHtmlEditor.CommandExecuted event — to determine the action performed by an end-user. If the ASPxClientHtmlEditorCommandEventArgs.commandName event parameter returns the INSERTLINK_COMMAND property value, this means that an end-user has clicked the OK button within the Insert Link dialog.
  • In the ASPxClientHtmlEditor.ExecuteCommand method — to execute the command manually.

    In this case, the method requires an additional parameter, which is an object of the ASPxClientHtmlEditorInsertLinkCommandArguments type.

    
    // Inserting a new hyperlink instead of the "myDiv" div
    var myDiv = htmlEditor.GetDesignViewDocument().getElementById("myDiv");
    var args = new ASPxClientHtmlEditorInsertLinkCommandArguments(htmlEditor, myDiv);
    args.target = "_blank";
    args.text = "Visit our website";
    args.title = "DevExpress";
    args.url = "http://www.devexpress.com";
    htmlEditor.ExecuteCommand(ASPxClientCommandConsts.INSERTLINK_COMMAND, args);
    
Note

This command is available only in the Design View.

See Also