Skip to main content

DocumentCapabilitiesOptions.Bookmarks Property

Gets or sets the bookmark feature availability.

Namespace: DevExpress.XtraRichEdit

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

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

Property Value

Type Default Description
DocumentCapability Default

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

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:

Object Type Path 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.

See Also