UndoItemCreator.BeginEditEx
- Updated2025-07-21
- 3 minute(s) read
UndoItemCreator.BeginEditEx
Syntax
UndoItemCreator.BeginEditEx( obj, lookupString)
Purpose
Call this method before you modify a TestStand object.
Remarks
The object you specify with the obj and lookupString parameters depends on which EditKinds enumeration value you passed to the Engine.NewUndoItemCreator method. For each of the following EditKinds enumeration values, pass the specified object.
- EditKind_ChangeNumericFormat –Pass the property object with the numeric format you are changing to this method.
- EditKind_ChangeObject –Pass the object you are modifying to this method. For this EditKind, an UndoItemCreator creates an undo item that restores all subproperties of the property object you pass in.
- EditKind_ChangeRunMode –Pass the step you are changing the run mode of to this method. Call Step.SetRunModeEx to change the run mode of a step.
- EditKind_ChangeSequenceFileProperties –Pass the sequence file you are modifying through the Sequence File Properties Dialog Box to this method.
- EditKind_ChangeSequenceProperties –Pass the sequence you are modifying through the Sequence Properties Dialog Box to this method.
- EditKind_ChangeStep –Pass the step with the properties you are changing to this method. For example, you could pass a step you are modifying through the Step Properties Dialog Box to this method.
- EditKind_ChangeValue –Pass the property object with the value you are changing to this method. Call a PropertyObject.SetVal method to change the value of a property object.
- EditKind_DeleteProperty –Pass the property object you are deleting to this method. Call the PropertyObject.DeleteSubProperty method to delete a property object.
- EditKind_DeleteSequence –Pass the sequence you are deleting to this method. Call the SequenceFile.DeleteSequence or SequenceFile.RemoveSequence method to delete a sequence.
- EditKind_DeleteStep –Pass the step you are deleting to this method. Call the Sequence.DeleteStep method to delete a step.
- EditKind_InsertProperty –Pass the property object you are inserting to this method. Call the PropertyObject.InsertSubProperty method to insert a property object.
- EditKind_InsertSequence –Pass the sequence you are inserting to this method. Call the SequenceFile.InsertSequenceEx method to insert a sequence.
- EditKind_InsertStep –Pass the step you are inserting to this method. Call the Sequence.InsertStep method to insert a step.
- EditKind_InsertType –Pass the type you are inserting to this method. Call the TypeUsageList.InsertType method to insert a type.
- EditKind_ModifyComment –Pass the property object with the comment you are changing to this method.
- EditKind_ModifyFlags –Pass the property object with the flags you are changing to this method.
- EditKind_MoveProperty –Pass the property object you are moving to this method. Call the PropertyObject.DeleteSubProperty method and then the PropertyObject.InsertSubProperty method to move a property object.
- EditKind_MoveSequence –Pass the sequence you are moving to this method. Call the SequenceFile.DeleteSequence or SequenceFile.RemoveSequence method and then the SequenceFile.InsertSequenceEx method to move a sequence.
- EditKind_MoveStep –Pass the step you are moving to this method. Call the Sequence.DeleteStep method and then the Sequence.InsertStep method to move a step.
- EditKind_Rename –Pass the property object you are renaming to this method.
- EditKind_ReplaceProperty –Pass the property object you are replacing to this method. Call the PropertyObject.SetPropertyObject method to replace a property object.
Parameters
obj As PropertyObject
[In] Specifies an object that contains the location the lookupString parameter specifies. If you are modifying an element of an array object, pass the array object or an object that contains the array object.
lookupString As String
[In] Pass an empty string to denote the obj parameter, or pass the name of a subproperty within obj for the object you are modifying or the array index if obj is an array object. Array index strings are a list of numbers, enclosed in brackets, that index each dimension of the array. For example, [0][1] is an array index for a two-dimensional array.
See Also
PropertyObject.DeleteSubProperty
PropertyObject.InsertSubProperty
PropertyObject.SetPropertyObject
Sequence File Properties dialog box
Sequence Properties dialog box