InsertHyperlinkCommand.execute(settings) Method

Executes the InsertHyperlinkCommand command with the specified parameter.

Declaration

execute(
    settings: HyperlinkSettings
): boolean

Parameters

Name	Type	Description
settings	HyperlinkSettings	A HyperlinkSettings object specifying hyperlink settings.

Returns

Type	Description
boolean	true if the command has been successfully executed; false if the command execution has failed.

Remarks

Usage example:

JS

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

richEdit.commands.insertHyperlink.execute(hyperlinkSettings);