DXRichEditDocumentCapabilitiesOptions.Hyperlinks Property

Gets ore sets the document’s capability to load, insert, modify and export the hyperlinks.

Namespace: DevExpress.Xpf.RichEdit

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

NuGet Package: DevExpress.Wpf.RichEdit

Declaration

C#

public DocumentCapability Hyperlinks { get; set; }

VB.NET

Public Property Hyperlinks As DocumentCapability

Property Value

Type	Description
DocumentCapability	A DocumentCapability enumeration value specifying the document’s capability to handle hyperlinks.

Available values:

Name	Description
Default	The value is determined by the current setting. The default value is automatically set if it is not explicitly specified.
Disabled	The feature is not allowed and the corresponding commands are shown disabled.
Enabled	The feature is available and the corresponding commands are shown enabled.
Hidden	The feature is not available and the corresponding commands are hidden.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Hyperlinks
RichEditControl	.DocumentCapabilitiesOptions .Hyperlinks

Remarks

This property affects the ability to create, modify, delete and follow hyperlinks in the document using the built-in features.

The DocumentCapability.Default value for the Hyperlinks property is equal to DocumentCapability.Enabled, so that the hyperlinks are available for a document currently loaded in the RichEditControl.

Note

The hyperlink is a specific kind of a document field, therefore the Fields property affects the hyperlink loading process when importing the document. Set the RichEditControlCompatibility.LoadHyperlinkAsField property to false before calling the InitializeComponent method to correct this behavior and allow loading hyperlinks when loading fields is disabled.