DocumentCapability Enum

Lists the availability of a certain functionality in the XtraRichEdit document.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

[ComVisible(true)]
public enum DocumentCapability

VB.NET

<ComVisible(True)>
Public Enum DocumentCapability

Members

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.

Remarks

Use the DocumentCapability enumeration to specify the RichEditBehaviorOptions and DocumentCapabilitiesOptions options.

In mosts cases, the DocumentCapability.Default property value is equal to the DocumentCapability.Enabled, so that the corresponding RichEditBehaviorOptions or DocumentCapabilitiesOptions feature is available for the RichEditControl document by default.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentCapability enum.

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#

wpf-spreadsheet-chart-api-t113198/CS/SpreadsheetWPFChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L126

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

spreadsheet-document-api-examples-part-2-t217615/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-chart-api-examples-t132724/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;

VB.NET

wpf-spreadsheet-chart-api-t113198/VB/SpreadsheetWPFChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L137

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

spreadsheet-document-api-examples-part-2-t217615/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-chart-api-examples-t132724/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