RichEditControl.HyperlinkOptions Property

Gets or sets the options specific to hyperlinks. This is a dependency property.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit

Declaration

C#

public DXRichEditHyperlinkOptions HyperlinkOptions { get; set; }

VB.NET

Public Property HyperlinkOptions As DXRichEditHyperlinkOptions

Property Value

Type	Description
DXRichEditHyperlinkOptions	A DXRichEditHyperlinkOptions object containing hyperlink options.

Remarks

Use the HyperlinkOptions property to specify additional keys required to activate a hyperlink when it’s clicked (the DXRichEditHyperlinkOptions.ModifierKeys property) and the tooltip visibility (the DXRichEditHyperlinkOptions.ShowToolTip property).

Use the SubDocument.Hyperlinks property to access the document hyperlinks collection.

To perform a custom action when the hyperlink is clicked, handle the RichEditControl.HyperlinkClick event.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HyperlinkOptions 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.

XAML

bookmarks-and-hyperlinks-simple-example-t549304/CS/BookmarksAndHyperlinksSimpleExample/MainWindow.xaml#L66

<!--region #hyperlinkoptions-->
<dxre:RichEditControl.HyperlinkOptions>
    <dxre:DXRichEditHyperlinkOptions ShowToolTip="{Binding IsChecked, ElementName=edtShowTooltip}"