UndoStack.AggregateTopUndoItems
- Updated2025-07-21
- 1 minute(s) read
UndoStack.AggregateTopUndoItems
Syntax
UndoStack.AggregateTopUndoItems( numItemsToAggregate, aggregateItemDescription = "", aggregatePreEditLocations = NULL, aggregatePostEditLocations = NULL)
Purpose
Combines a specified number of items on the top of the undo stack into one item.
Parameters
numItemsToAggregate As Long
[In] Specifies the number of items to combine into one item.
aggregateItemDescription As String
[In] Specifies the UndoItem.UndoDescription and UndoItem.RedoDescription properties of the aggregate item. If you pass an empty string, the aggregate item uses the UndoItem.UndoDescription and UndoItem.RedoDescription properties of the lowest undo item on the stack this method aggregates.
This parameter has a default value of "" .
aggregatePreEditLocations As Locations
[In] Specifies the UndoItem.PreEditLocations property of the aggregate undo item. If you pass NULL , the aggregate undo item computes the UndoItem.PreEditLocations property from the UndoItem.PreEditLocations of the aggregated undo items.
This parameter has a default value of NULL .
aggregatePostEditLocations As Locations
[In] Specifies the UndoItem.PostEditLocations property of the aggregate undo item. If you pass NULL , the aggregate undo item computes the UndoItem.PostEditLocations from the UndoItem.PostEditLocations of the aggregated undo items.
This parameter has a default value of NULL .