ChangeDefinition Object

Description

The ChangeDefinition object is obtained from the ChangeManager object. It's purpose is to provide a ChangeProcessor object via the CreateChangeProcessor method, according to the settings of the ChangeDefinition object.

Methods

Name Description
CreateChangeProcessor Creates a new ChangeProcessor object based on this definition.
Delete Deletes this ChangeDefinition.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
ChangeType Gets and sets the type of change (shape edit, query only, etc.) that this ChangeDefinition represents. Defaults kShapeEditCmdType.
ClientId Gets the Client Id string for this definition.
CommandName Gets the command name associated with this ChangeDefinition. This localized string shows up in the undo list.
InternalName Gets the internal name of the ChangeDefinition. This is a unique string that may be used to reliably retrieve a ChangeDefinition object.
Parent Gets the parent object from whom this object can logically be reached.
Type Returns an ObjectTypeEnum indicating this object's type.

Events

Name Description
OnReplay Event that is fired by Inventor in a script replay scenario. In the handler of this event (typically, written by the client who created this ChangeDefinition), it is expected that a new ChangeProcessor will be generated using the CreateChangeProcessor method of this object, followed by the client proceeding to 'hook up' its ChangeProcessor handler code, and returning this hooked-up processor back. Inventor will then use this returned ChangeProcessor to replay the scripted command.

Accessed From

ChangeDefinitions.Add, ChangeDefinitions.Item, ChangeProcessor.Parent

Version

Introduced in version 9