Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

HyperlinkInfo Class

Contains information about a hyperlink.

#Declaration

TypeScript
export class HyperlinkInfo

#Remarks

var text = "Visit our site";
var url = "https://www.devexpress.com/";
var tooltip = "DevExpress site";

richEdit.beginUpdate();
richEdit.history.beginTransaction();
var subDocument = richEdit.selection.activeSubDocument;

var position = richEdit.selection.active;
position = subDocument.insertParagraph(position).interval.end;
position = subDocument.hyperlinks.create(position, new DevExpress.RichEdit.HyperlinkInfo(text, url, "", tooltip)).interval.end;
subDocument.insertParagraph(position);

richEdit.endUpdate();
richEdit.history.endTransaction();

#constructor(text)

Initializes a new instance of the HyperlinkInfo class with specified settings.

#Declaration

TypeScript
constructor(
    text: string,
    url?: string,
    bookmark?: string,
    tooltip?: string
)

#Parameters

Name Type Description
text string

The hyperlink text.

url string

The hyperlink URL.

bookmark string

The name of a bookmark to which the hyperlink navigate.

tooltip string

The hyperlink tooltip text.

#Properties

#bookmark Property

The name of a bookmark to which the hyperlink navigate.

#Declaration

TypeScript
bookmark: string

#Property Value

Type Description
string

A bookmark name.

#Remarks

If the bookmark property is specified, the url property is not in effect.

#text Property

Specifies the hyperlink text.

#Declaration

TypeScript
text: string

#Property Value

Type Description
string

The hyperlink text.

#tooltip Property

Specifies the hyperlink tooltip text.

#Declaration

TypeScript
tooltip: string

#Property Value

Type Description
string

The tooltip text.

#url Property

Specifies the hyperlink URL.

#Declaration

TypeScript
url: string

#Property Value

Type Description
string

The hyperlink URL.

#Remarks

If the bookmark property is specified, the url property is not in effect.