RichEditCommands.insertHyperlink Property

Gets a command to insert and update a hyperlink field in place of a selected range.

Declaration

TypeScript

get insertHyperlink(): InsertHyperlinkCommand

Property Value

Type	Description
InsertHyperlinkCommand	An object that provides methods that execute the command and check its state.

Remarks

Call the execute(settings) method to invoke the command. The method checks the command state (obtained via the getState method) to determine whether the action can be performed.

JS

var hyperlinkSettings = {
    url: 'https://www.devexpress.com/',
    text: 'Link',
    tooltip: 'Click to redirect'
};

richEdit.commands.insertHyperlink.execute(hyperlinkSettings);

Refer to the following section for more information: Client Commands.