RichEditControlOptionsBase.Hyperlinks Property
Provides access to options specific to hyperlinks.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v18.2.Core.dll
Declaration
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:
| Library | Object Type | Path to Hyperlinks |
|---|---|---|
| WinForms Controls | SnapControl |
|
| RichEditControl |
|
|
| WPF Controls | RichEditControl |
|
| Office File API | IRichEditDocumentServer |
|
| RichEditDocumentServer |
|
|
| Reporting | SyntaxEditor |
|
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.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Hyperlinks property.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.