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

DocumentCapabilitiesOptions.Hyperlinks Property

Gets or sets the hyperlink feature availability.

Namespace: DevExpress.XtraRichEdit

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

Declaration

Property Value

Type Default Description
DocumentCapability

Default

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

Property Paths

You can access this nested property as listed below:

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 currently loaded document.

With the Hyperlinks property set to DocumentCapability.Disabled, existing hyperlinks become inactive for end-users.

Note

The hyperlink is a specific kind of a document field, therefore the DocumentCapabilitiesOptions.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.

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

See Also