HyperlinkOptions.ModifierKeys Property

Gets or sets the modifier flags required to activate a hyperlink. The flags indicate which combination of CTRL, SHIFT, and ALT keys should be pressed before a link is clicked, to activate it.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[XtraSerializableProperty]
[TypeConverter("DevExpress.XtraRichEdit.Design.ModifiersConverter, DevExpress.XtraRichEdit.v19.1.Design")]
public Keys ModifierKeys { get; set; }

VB.NET

<XtraSerializableProperty>
<TypeConverter("DevExpress.XtraRichEdit.Design.ModifiersConverter, DevExpress.XtraRichEdit.v19.1.Design")>
Public Property ModifierKeys As Keys

Property Value

Type	Description
Keys	A Keys value representing one or more modifier flags.

Property Value

Type	Description
DevExpress.Compatibility.System.Windows.Forms.Keys	A Keys value representing one or more modifier flags.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to ModifierKeys
WinForms Controls	SnapControlOptions	.Hyperlinks.ModifierKeys
	RichEditControlOptions	.Hyperlinks.ModifierKeys
WPF Controls	RichEditControlOptions	.Hyperlinks.ModifierKeys
Office File API	RichEditControlOptionsBase	.Hyperlinks.ModifierKeys

Remarks

Use the Modifiers property to specify which modifier keys should be pressed to navigate the hyperlink when it is clicked. Set it to the System.Windows.Forms.Keys.None value to activate hyperlink with a simple mouse click.

Tip

Handle the RichEditControl.HyperlinkClick event to perform a custom operation when a hyperlink is clicked.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ModifierKeys 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.

C#

bookmarks-and-hyperlinks-simple-example-t548777/CS/BookmarksAndHyperlinksSimpleExample/Form1.cs#L35

hyperlinkOptions.EnableUriCorrection = false;
hyperlinkOptions.ModifierKeys = Keys.Shift;
hyperlinkOptions.ShowToolTip = true;

generating-table-of-contents-toc-practical-guide-e4138/CS/Form1.cs#L14

InitializeComponent();
richEditControl1.Options.Hyperlinks.ModifierKeys = Keys.None;
btnLoadTemplate_Click(btnLoadTemplate, EventArgs.Empty);

how-to-implement-navigation-between-a-set-of-referenced-documents-e4140/CS/Form1.cs#L17

richEditControl1.ReadOnly = true;
richEditControl1.Options.Hyperlinks.ModifierKeys = Keys.None;
NavigateTo(startPage, true);

VB.NET

bookmarks-and-hyperlinks-simple-example-t548777/VB/BookmarksAndHyperlinksSimpleExample/Form1.vb#L33

hyperlinkOptions.EnableUriCorrection = False
hyperlinkOptions.ModifierKeys = Keys.Shift
hyperlinkOptions.ShowToolTip = True

generating-table-of-contents-toc-practical-guide-e4138/VB/Form1.vb#L20

InitializeComponent()
richEditControl1.Options.Hyperlinks.ModifierKeys = Keys.None
btnLoadTemplate_Click(btnLoadTemplate, EventArgs.Empty)

how-to-implement-navigation-between-a-set-of-referenced-documents-e4140/VB/Form1.vb#L19

richEditControl1.ReadOnly = True
richEditControl1.Options.Hyperlinks.ModifierKeys = Keys.None
NavigateTo(startPage, True)