Share

ComponentOccurrenceProxy Object

Derived from: ComponentOccurrence Object

Description

This is an assembly-context proxy object derived from its native definition-context object.

Methods

Name Description
ChangeRowOfiAssemblyMember Method that changes the row in the iAssemblyFactory this occurrence references. This method can be used only if the IsiAssemblyMember property returns True.
ChangeRowOfiPartMember Method that changes the row in the iPartTable this iPartMember represents. This method can be used only if the iPartMember property is True.
CreateGeometryProxy Method that creates a proxy object for input object. A proxy object represents another object within the assembly space. Queries made on the proxy object are returned with respect to the assembly space, not the space the real geometry exists in.
Delete Method that deletes the occurrence. This is the equivalent of the user deleting the occurrence interactively.
Delete2 Deletes this component occurrence.
Edit Activates this component occurrence for editing by the end user via the user interface.
ExitEdit Method that causes the component occurrence to return from the edit mode and into the environment specified by the input argument. If the ComponentOccurrence is not currently active (i.e. this is not the same occurrence as returned by AssemblyComponentDefinition.ActiveOccurrence), then this method does nothing.
GetDegreesOfFreedom Method that returns the available degrees of freedom for the occurrence.
GetDisplayMode Gets the display mode type - default or override.
GetReferenceKey Method that generates and returns the reference key for this entity.
Replace Method that replaces the occurrence or all instances of an occurrence with another file.
Replace2 Replaces this component occurrence with another component. Can save replaced component and unset adaptivity.
SetDesignViewRepresentation Method that sets a design view representation for an assembly occurrence.
SetDisplayMode Sets the display mode and type - default or override.
SetTransformWithoutConstraints Method that sets the position and orientation of the occurrence, ignoring any constraints on the occurrence. When the assembly is recomputed the occurrence will reposition to honor the constraints.
ShowRelationships Method that shows all of the assembly constraints, joints and iMate objects associated with this occurrence.
Suppress Suppresses this occurrence.
Unsuppress Method that unsuppresses the occurrence.

Properties

Name Description
ActiveModelState Read-write property that gets and sets the name of the active model state for an assembly occurrence.
ActivePositionalRepresentation Gets and sets the active Positional Representation for this occurrence.
Adaptive 'Put' is Inventor Only: Gets/Sets the Boolean flag that specifies whether this Occurrence is adaptive or not.
Appearance Gets and sets the current appearance of the component occurrence.
AppearanceSourceType Gets and sets the source of the appearance for the component occurrence.
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.
AssociativeForeignFilename Read-only property that returns the full file name of the associative foreign file. This property returns empty string if the IsAssociativelyImported returns False.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
BOMStructure Gets and sets the BOM structure override.
Constraints Property returns the collection of constraints that are acting on the occurrence.
ContactSet Gets and sets whether the component belongs in the contact set.
ContainingOccurrence Property that returns the ComponentOccurrence that the native object is being referenced through. The returned occurrence is the containing occurrence.
ContextDefinition Property that returns the object this occurrence is in the context of. For example, all coordinate data returned by the definition is in the space of this ComponentDefinition.
Definition Property that returns the object this occurrence references.
DefinitionDocumentType Gets the type of the Document whose occurrence this is.
DisabledActionTypes Gets and sets the action types valid for this component occurrence.
Enabled 'Put' is Inventor Only: Gets/Sets the Boolean flag that specifies whether this Occurrence is enabled or not.
Excluded Read-write property that gets and sets whether the occurrence is excluded in the active row of the iAssembly factory. This property returns False and cannot be set to True if the parent document is not an iAssembly.
Flexible Only works for assembly occurrences. Gets and sets the Boolean flag that specifies whether the assembly is flexible.
Grounded 'Put' is Inventor Only: Gets/Sets the Boolean flag that specifies whether this Occurrence is grounded or not.
HasAssociativeImportedComponent Read-only property that returns whether the ComponentOccurrence has an associative imported component.
HasBodyOverride Property that returns a Boolean specifying whether the occurrence path contains body-modifying assembly features.
iMateDefinitions Property that returns the iMateDefinitions that are available from this occurrence. The iMateDefinition objects returned are actually proxies for the various iMateDefinition objects. These can be used as input to the Add and ValidResult methods of the iMateResults object.
ImportedComponent Read-only property that returns the associative ImportedComponent object if the HasAssociativeImportedComponent returns True.
IsAssociativelyImported Gets whether this occurrence is an associatively imported occurrence.
IsAssociativeToDesignViewRepresentation Gets and sets whether this occurrence is associative to a design view representation.
IsiAssemblyMember Property that returns whether the ComponentOccurrence is an iAssemblyMember. The property returns True if the ComponentOccurrence is an iAssemblyMember. This property always returns False for occurrences of part documents.
IsiPartMember Property that specifies if the ComponentOccurence is an iPartMember. The property is True if the ComponentOccurence is an iPartMember.
IsPatternElement Property that indicates whether this occurrence represents a pattern element. In the case where this occurrence represents a pattern element, this property returns True. The PatternElement property can be used to get that pattern element.
IsSubstituteOccurrence Property that returns whether this occurrence references a substitute part in the context of a substitute model state.
Joints Inventor Only: Gets the enumerator that presents the joints applied on this Component Occurrence.
MassProperties Property that returns the MassProperties object. This supports performing mass properties calculations for this particular occurrence.
Name Gets/Sets the human-readable name of this Component Occurrence.
NativeObject Gets the object in the context of the definition instead of the containing assembly.
OccurrencePath Gets the path of immediate (directly instanced) occurrences that make up this occurrence.
OccurrencePropertySets Read-only property that returns a PropertySets object associated with the occurence.
OccurrencePropertySetsEnabled Read-write property that gets and sets whether this occurrence has a PropertySets object.
OrientedMinimumRangeBox Read-only property that returns the oriented minimum range box for this object.
OverrideOpacity Gets and sets the opacity of an occurrence.
Parent Gets the parent object from whom this object can logically be reached.
ParentOccurrence Property that returns the parent of this occurrence. This property is only valid for the occurrences in a multi-level assembly that are not in the top level. The parent occurrence is the occurrence representing the subassembly this occurrence is contained within.
PatternElement Property that returns the pattern element this occurrence represents. In the case where this occurrence is not part of a pattern this property returns Nothing. The IsPatternElement property can be used to check if this occurrence is part of a pattern.
PreciseRangeBox Property that returns a Box object which contains the opposing points of a rectangular box that tightly encloses this object.
RangeBox Property that returns a Box object which contains the opposing points of a rectangular box that is guaranteed to enclose this object.
ReferencedDocumentDescriptor Property that returns an enumeration of descriptors that represent the native document references held by this document.
ShowDegreesOfFreedom Gets and sets whether to display the degrees of freedom for the occurrence.
SubOccurrences Property that returns the collection of occurrences for an occurrence. This property applies to occurrences that represent a subassembly. The collection returned provides access to the occurrences contained within the subassembly. If this collection is obtained from an occurrence that represents a part, it will not contain any occurrences.
Suppressed Property that returns whether this occurrence is suppressed or not.
SurfaceBodies Property that returns the SurfaceBodies collection for the occurrence. This property applies to occurrences that represent a part and provides access to the B-Rep of that part. The B-Rep queries will return coordinate data in the context of the component definition that served as the starting point to access the occurrence, which can also be accessed through the ContextDefinition property.
Transformation Property that returns and sets the transformation for the occurrence. The transformation matrix defines the position and orientation of the component within the assembly. When setting the transform of an occurrence the actual change in position and orientation of the occurrence is limited by the constraints on the occurrence.
Transparent 'Put' is Inventor Only: Gets/Sets the Boolean flag that specifies whether this Occurrence is transparent or not.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible 'Put' is Inventor Only: Gets/Sets the Boolean flag that specifies whether this Occurrence is visible or not.

Samples

Name Description
Promote occurence This sample demonstrates how to promote an occurrence.
Print instance properties of all components in an assembly This sample demonstrates how to get the instance properties of all components in an assembly.

Version

Introduced in version 4

Was this information helpful?