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

RichEditCommands.changeHyperlink Property

Gets a command that changes the specified hyperlink.


readonly changeHyperlink: ChangeHyperlinkCommand

Property Value

Type Description

A ChangeHyperlinkCommand object that provides methods for executing the command and checking its state.


You can invoke this command by calling the execute method.

The execute method checks the command state (obtained using the getState method) before executing, and decides whether the action can be performed. The execute and getState methods are members of the ChangeHyperlinkCommand class.

Usage example:

var field = richEdit.document.activeSubDocument.findFields(richEdit.selection.intervals[0].start)[0];
if (field && field.isHyperlink){
    var hyperlinkSettings = new ASPx.HyperlinkSettings ("", "", "click me", "go to google");
    richEdit.commands.changeHyperlink.execute(field.index, hyperlinkSettings);

Use the Field.isHyperlink property to determine whether the specified field is a hyperlink.

See Also