Back to Devexpress

DocumentCapabilitiesOptions.Bookmarks Property

officefileapi-devexpress-dot-xtrarichedit-dot-documentcapabilitiesoptions-11fc25cd.md

latest8.0 KB
Original Source

DocumentCapabilitiesOptions.Bookmarks Property

Gets or sets the bookmark feature availability.

Namespace : DevExpress.XtraRichEdit

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
[DefaultValue(DocumentCapability.Default)]
public virtual DocumentCapability Bookmarks { get; set; }
vb
<DefaultValue(DocumentCapability.Default)>
Public Overridable Property Bookmarks As DocumentCapability

Property Value

TypeDefaultDescription
DocumentCapabilityDefault

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

|

Available values:

NameDescription
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 TypePath to Bookmarks
RichEditControlOptionsBase

.DocumentCapabilities .Bookmarks

|

Remarks

This property affects the behavior of the CreateBookmarkCommand, the DeleteBookmarkCommand and the ShowBookmarkFormCommand commands.

The DocumentCapability.Default value for the Bookmarks property is equal to DocumentCapability.Enabled, so that bookmarks can be displayed for a currently loaded document.

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

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

csharp
//options.DocumentCapabilities.ParagraphFormatting = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled;

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L156

csharp
options.DocumentCapabilities.Tables = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled;

winforms-spreadsheet-chart-api/CS/SpreadsheetChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L134

csharp
//options.DocumentCapabilities.ParagraphFormatting = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled;

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.cs#L156

csharp
options.DocumentCapabilities.Tables = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled;

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/CodeUtils/ExampleCodeEditor.cs#L203

csharp
options.DocumentCapabilities.Tables = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled;

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

vb
'options.DocumentCapabilities.ParagraphFormatting = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L142

vb
options.DocumentCapabilities.Tables = DocumentCapability.Disabled
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled

winforms-spreadsheet-chart-api/VB/SpreadsheetChartAPISamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L144

vb
'options.DocumentCapabilities.ParagraphFormatting = DocumentCapability.Disabled;
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeUtils/SpreadsheetApiModuleUtils.vb#L142

vb
options.DocumentCapabilities.Tables = DocumentCapability.Disabled
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/CodeUtils/ExampleCodeEditor.vb#L187

vb
options.DocumentCapabilities.Tables = DocumentCapability.Disabled
options.DocumentCapabilities.Bookmarks = DocumentCapability.Disabled
options.DocumentCapabilities.CharacterStyle = DocumentCapability.Disabled

See Also

DocumentCapabilitiesOptions Class

DocumentCapabilitiesOptions Members

DevExpress.XtraRichEdit Namespace