DocumentCapabilitiesOptions.Hyperlinks Property

Gets or sets the hyperlink feature availability.

Namespace: DevExpress.XtraRichEdit

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability Hyperlinks { get; set; }

VB.NET

<DefaultValue(DocumentCapability.Default)>
Public Overridable Property Hyperlinks As DocumentCapability

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:

Show 11 property paths

Library	Object Type	Path to Hyperlinks
WinForms Controls	SnapControl	.Options .Hyperlinks
	SnapControl	.DocumentCapabilities .Hyperlinks
	SnapControlOptions	.DocumentCapabilities .Hyperlinks
	RichEditControl	.Options .Hyperlinks
RichEditControl	.DocumentCapabilities .Hyperlinks
RichEditControlOptions	.DocumentCapabilities .Hyperlinks
WPF Controls	RichEditControl	.Options .Hyperlinks
	RichEditControl	.DocumentCapabilities .Hyperlinks
RichEditControlOptions	.DocumentCapabilities .Hyperlinks
Office File API	IRichEditDocumentServer	.Options .Hyperlinks
	IRichEditDocumentServer	.DocumentCapabilities .Hyperlinks
	RichEditControlOptionsBase	.DocumentCapabilities .Hyperlinks
RichEditDocumentServer	.Options .Hyperlinks
RichEditDocumentServer	.DocumentCapabilities .Hyperlinks
Reporting	SyntaxEditor	.Options .Hyperlinks
SyntaxEditor	.DocumentCapabilities .Hyperlinks
ASP.NET Web Forms Controls	ASPxRichEditSettings	.DocumentCapabilities .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 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.

C#

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeUtils/SpreadsheetApiModuleUtils.cs#L151

RichEditControlOptionsBase options = codeEditor.InnerDocumentServer.Options;
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled;
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled;

wpf-spreadsheetcontrol-api-part-3-t289419/CS/SpreadsheetControl_WPF_API_Part03/CodeUtils/ExampleCodeEditor.cs#L199

RichEditControlOptionsBase options = codeEditor.InnerDocumentServer.Options;
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled;
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled;

spreadsheet-document-api-chart-examples/CS/SpreadsheetDocServerChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L126

RichEditControlOptionsBase options = codeEditor.InnerDocumentServer.Options;
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled;
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled;

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeUtils/RichEditAPIUtils.cs#L184

RichEditControlOptionsBase options = codeEditor.InnerDocumentServer.Options;
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled;
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled;

wpf-spreadsheet-pivot-table-api-t314425/CS/SpreadsheetWPFPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L150

RichEditControlOptionsBase options = codeEditor.InnerDocumentServer.Options;
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled;
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled;

VB.NET

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeUtils/SpreadsheetApiModuleUtils.vb#L137

Dim options As RichEditControlOptionsBase = codeEditor.InnerDocumentServer.Options
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled

wpf-spreadsheetcontrol-api-part-3-t289419/VB/SpreadsheetControl_WPF_API_Part03/CodeUtils/ExampleCodeEditor.vb#L183

Dim options As RichEditControlOptionsBase = codeEditor.InnerDocumentServer.Options
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled

spreadsheet-document-api-chart-examples/VB/SpreadsheetDocServerChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L137

Dim options As RichEditControlOptionsBase = codeEditor.InnerDocumentServer.Options
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeUtils/RichEditAPIUtils.vb#L169

Dim options As RichEditControlOptionsBase = codeEditor.InnerDocumentServer.Options
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled

wpf-spreadsheet-pivot-table-api-t314425/VB/SpreadsheetWPFPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L136

Dim options As RichEditControlOptionsBase = codeEditor.InnerDocumentServer.Options
options.DocumentCapabilities.Hyperlinks = DocumentCapability.Disabled
options.DocumentCapabilities.Numbering.Bulleted = DocumentCapability.Disabled