IDLitOperation::RecordInitialValues
Syntax | Return Value | Arguments | Keywords | Version History
The IDLitOperation::RecordInitialValues function method records the information needed to undo an operation. Information about individual operations is recorded in IDLitCommand objects, which are in turn stored in an IDLitCommandSet object that is passed to the IDLitOperation::UndoOperation and IDLitOperation::RedoOperation methods.
Note
If you are creating an operation that acts directly on the data that underlies a visualization, consider using the IDLitDataOperation class rather than the IDLitOperation class. IDLitDataOperation provides additional automation of the Undo and Redo mechanisms.
If this method is implemented for an operation, it should do the following:
- Create an IDLitCommand object, setting its TARGET_IDENTIFIER property to the identifier of the target object
- Record any information necessary to redo the operation in the IDLitCommand object
- Add the IDLitCommand object to the IDLitCommandSet object specified as the first parameter
- Return 1 for success
Syntax
Result = Obj->[IDLitOperation::]RecordInitialValues(CommandSet, Targets [, IdProperty])
Return Value
The return value is 1 if the initial values were recorded successfully, or zero otherwise.
Arguments
CommandSet
An IDLitCommandSet object that encapsulates all information recorded for this execution of the operation. The command set object is generally created by the IDLitOperation::DoAction method, which then calls the RecordInitialValues method to store the initial state of the target object.
Targets
An array of objects that are the targets of this operation. In most cases, the target objects are the currently selected objects, as returned by the IDLitTool::GetSelectedItems method.
IdProperty
A property identifier string specifying the target property or parameter of the operation.
Keywords
None
Version History
