ModelState Object


Description

ModelState Object.

Methods

Name Description
Activate Method that activates the model state.
Copy Method that creates a copy of the ModelState. The new created ModelState is returned.
CopyComponentSuppressionToVisibility Method that creates a new design view representation based on the suppression of components as defined by this model state. The newly created DesignViewRepresentation is returned.
Delete Method that deletes the ModelState. The method returns an error if this is a built-in ModelState.
GetReferenceKey Generate the sequence of bytes, called this object's reference key, which can be held onto beyond document edits and which will allow the caller to be bound back to the live object.

Properties

Name Description
Application Gets the root Application object. Where the property is weakly-typed, it can be set to (QueryInterfaced for) 'Application' when running with Inventor whereas, 'ApprenticeServer' when running with the Apprentice Server.
AttributeSets Gets the Attribute Sets collection on this object.
BOMDelegate Read-only property that returns the ModelState which this ModelState's BOM is delegated to.
Document Read-only property that returns the model state member Document that associates with this model state.
FactoryDocument Read-only property that returns the model state factory Document. If the model state factory document is not open, query this property will cause it open.
ModelStateType Read-only property that returns the enum indicating the model state type. This can be kMasterModelState, kSubstituteModelState, or kCustomModelState.
Name Read-write property that gets and sets the name of the ModelState. When setting the name, the name must be unique with respect to all other ModelState objects in the document, or an error will occur. Setting this property returns an error if this is a built-in.
Parent Gets the parent object from whom this object can logically be reached.
SubstituteDocumentDescriptor Read-only property that returns the DocumentDescriptor of the document associated with the substitute occurrence. This property returns Nothing if the ModelState property returns anything but kSubstituteModelState.
SubstituteOccurrence Read-only property that returns the ComponentOccurrence object associated with this model state. This property returns Nothing if the ModelState property returns anything but kSubstituteModelState.
Type Gets the constant that indicates the type of this object.

Accessed From

DesignViewRepresentation.CopyComponentVisibilityToSuppression, ModelState.BOMDelegate, ModelState.Copy, ModelStates.ActiveModelState, ModelStates.Add, ModelStates.AddSubstitute, ModelStates.Item

Samples

Name Description
Create a model state This sample demonstrates creation of a model state in an assembly.
Shrink wrap substitute in assembly The following sample demonstrates the creation of a shrinkwrap substitute within an assembly.

Version

Introduced in version 2022