DocumentCapabilitiesOptions.Hyperlinks Property
Gets or sets the hyperlink feature availability.
Namespace: DevExpress.XtraRichEdit
Assembly: DevExpress.RichEdit.v18.2.Core.dll
Declaration
[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability Hyperlinks { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| DocumentCapability | **Default** | A DocumentCapability enumeration 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:
| Library | Object Type | Path to Hyperlinks |
|---|---|---|
| WinForms Controls | SnapControl |
|
| SnapControlOptions |
|
|
| RichEditControl |
|
|
| RichEditControlOptions |
|
|
| WPF Controls | RichEditControl |
|
| RichEditControlOptions |
|
|
| Office File API | IRichEditDocumentServer |
|
| RichEditControlOptionsBase |
|
|
| RichEditDocumentServer |
|
|
| Reporting | SyntaxEditor |
|
| ASP.NET Web Forms Controls | ASPxRichEditSettings |
|
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.
Related GitHub Examples
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.