UndoCapacity Property

Summary

Gets or sets a value that specifies the capacity of the undo/redo buffer.

Syntax

C++

public virtual int UndoCapacity { get; set; }

  
Public Overridable Property UndoCapacity As Integer

public: 
virtual property int UndoCapacity { 
   int get(); 
   void set (    int ); 
}

Property Value

The number of user actions that can be reversed using Undo or re-applied using Redo.

Remarks

The AnnAutomation class keeps an internal undo/redo buffer. This internal buffer is updated automatically whenever the user changes objects inside the Container property.

The UndoCapacity property specifies the maximum number of items that are held inside this internal buffer. The default is set at 10. For example, if this buffer has a value of 10, the last 10 reversible operations will be saved in the buffer. Once the internal buffer capacity is reached, each new operation causes the operation at the bottom of the buffer to be removed.

Setting an UndoCapacity of 0 disables the undo/redo functionality for this AnnAutomation object.

For more information, refer to Undoing Automation Operations. (Deprecated)

Example

For an example, refer to AnnAutomationManager.

Requirements

Target Platforms