Back to Devexpress

HyperlinkOptions.ModifierKeys Property

officefileapi-devexpress-dot-xtrarichedit-dot-hyperlinkoptions.md

latest4.3 KB
Original Source

HyperlinkOptions.ModifierKeys Property

Gets or sets the modifier keys (CTRL, SHIFT, and ALT) required to activate a hyperlink.

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
[TypeConverter("DevExpress.XtraRichEdit.Design.ModifiersConverter, DevExpress.XtraRichEdit.v25.2.Design")]
[XtraSerializableProperty]
public PortableKeys ModifierKeys { get; set; }
vb
<XtraSerializableProperty>
<TypeConverter("DevExpress.XtraRichEdit.Design.ModifiersConverter, DevExpress.XtraRichEdit.v25.2.Design")>
Public Property ModifierKeys As PortableKeys

Property Value

TypeDescription
DevExpress.Portable.Input.PortableKeys

The equivalent of the System.Windows.Forms.Keys enumeration. Represents the modifier keys.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to ModifierKeys
RichEditControlOptionsBase

.Hyperlinks .ModifierKeys

|

Remarks

Use the Modifiers property to specify which modifier keys a user should press to open a hyperlink. Set this property to Keys.None to use only the mouse to activate hyperlinks.

Tip

Handle the RichEditControl.HyperlinkClick event to perform any actions when a hyperlink is clicked.

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.

word-processing-table-of-contents-practical-guide/CS/Program.cs#L38

csharp
{
    wordProcessor.Options.Hyperlinks.ModifierKeys = PortableKeys.None;
    wordProcessor.LoadDocument("Employees.rtf");

winforms-richedit-table-of-contents-practical-guide/CS/Form1.cs#L15

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

word-processing-table-of-contents-practical-guide/VB/Program.vb#L34

vb
Using wordProcessor As New RichEditDocumentServer()
    wordProcessor.Options.Hyperlinks.ModifierKeys = PortableKeys.None
    wordProcessor.LoadDocument("Employees.rtf")

winforms-richedit-table-of-contents-practical-guide/VB/Form1.vb#L23

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

See Also

HyperlinkClick

HyperlinkOptions Class

HyperlinkOptions Members

DevExpress.XtraRichEdit Namespace