.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

Hyperlink Interface

Defines a hyperlink in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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



The Hyperlink marks the document range (the Hyperlink.Range property) as the hot spot in the document. It can be activated by clicking or pressing Enter (note that the EnterKeyCommand does exactly the same thing) to navigate the Hyperlink.NavigateUri (or Hyperlink.Anchor if it is linked to a Bookmark). The link is opened in the frame specified by the Hyperlink.Target property. Hyperlink has a Hyperlink.ToolTip and can be marked as Hyperlink.Visited.

Hyperlinks are contained in the SubDocument.Hyperlinks collection of the document. To create a new hyperlink and add it to the collection, use the HyperlinkCollection.Create method or invoke the end-user form using the ShowHyperlinkFormCommand command.

When clicked (or activated by another means), a hyperlink fires the RichEditControl.HyperlinkClick event.

Common hyperlink characteristics, such as the key modifier, required for activating the hyperlink by mouse click as well as tooltip visibility, can be specified via the RichEditControlOptionsBase.Hyperlinks options of the RichEditControl. For example, to activate a hyperlink with a simple mouse click, without having to hold CTRL key, set the HyperlinkOptions.ModifierKeys to the None value.

See Also