RichEditControlOptionsBase.Hyperlinks Property

Provides access to options specific to hyperlinks.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v23.2.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public HyperlinkOptions Hyperlinks { get; }

VB.NET

Public ReadOnly Property Hyperlinks As HyperlinkOptions

Property Value

Type	Description
HyperlinkOptions	A HyperlinkOptions class instance containing options specific to hyperlinks.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Hyperlinks
IRichEditDocumentServer	.Options .Hyperlinks
RichEditDocumentServer	.Options .Hyperlinks

Remarks

Use the Hyperlinks property to specify additional keys required to activate a hyperlink when it is clicked (via the HyperlinkOptions.ModifierKeys property) and tooltip visibility (via the HyperlinkOptions.ShowToolTip property).

To access the collection of hyperlinks in the current document, use the SubDocument.Hyperlinks property.

You can handle the RichEditControl.HyperlinkClick event, to perform a custom action when a hyperlink is clicked.