UndoItemCreator.CreateAndPostUndoItem

Syntax

UndoItemCreator.CreateAndPostUndoItem( options = 0, locationsApplicationSite = ApplicationSite_DefaultSite, [locationsUserData])

Return Value

UndoItem

Purpose

Call this method to create an undo item that can undo and redo edits. This method sends the undo item to the sequence editor using a synchronous UIMsg_PushUndoItem user interface message and then returns the created undo item.

Remarks

Do not call this method if the UndoItemCreator.HaveEditsBeenMade property is False . You also need to increment the change count of the edited file before calling this method.

Parameters

options As Long

[In] Specifies any combination of CreateUndoItemOptions .

This parameter has a default value of 0 .

locationsApplicationSite As ApplicationSites

[In] Specifies the value of the Locations.ApplicationSite properties of the undo item this method creates.

This parameter has a default value of ApplicationSite_DefaultSite .

locationsUserData As Variant

[In] [ Optional ] Specifies the value of the Locations.UserData properties of the undo item this method creates.

See Also

ApplicationSites

CreateUndoItemOptions

Locations.ApplicationSite

Locations.UserData

Omitting Optional Parameters

PropertyObjectFile.IncChangeCount

UIMessageCodes

UndoItem

UndoItemCreator.HaveEditsBeenMade