DocumentCapabilitiesOptions.Undo Property

Gets or sets the availability of the Undo/Redo feature.

Namespace: DevExpress.XtraRichEdit

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

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
DocumentCapability	Default	A DocumentCapability enumeration specifying the availability of the Undo/Redo feature.

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 Undo
RichEditControlOptionsBase	.DocumentCapabilities .Undo

Remarks

This property affects the UndoCommand and the RedoCommand commands behavior.

The DocumentCapability.Default value for the Undo property is equal to DocumentCapability.Enabled, so that the Undo/Redo feature is available for a currently loaded document.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Undo 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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/SnapLayoutProcessor.cs#L42

//Disable history to avoid potential document changing conflicts
server.Options.DocumentCapabilities.Undo = DevExpress.XtraRichEdit.DocumentCapability.Disabled;

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/SnapLayoutProcessor.vb#L41

'Disable history to avoid potential document changing conflicts
server.Options.DocumentCapabilities.Undo = DevExpress.XtraRichEdit.DocumentCapability.Disabled
'Create and initialize collections