Share

RectangularOccurrencePattern Object

Derived from: OccurrencePattern Object

Description

The RectangularOccurrencePattern object represents a rectangular pattern of assembly occurrences.

Methods

Name Description
Delete Method that deletes the pattern.
GetReferenceKey Method that generates and returns the reference key for this entity.
Suppress Suppress the occurrence pattern.
Unsuppress Unsuppress the occurrence pattern.

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.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
ColumnCount Property returning the Parameter object that controls the number of columns.
ColumnEntity Gets/Sets the entity used to define the column (x) direction of the pattern.
ColumnEntityNaturalDirection Gets/Sets whether the column direction is in the natural direction of the column entity or not.
ColumnOffset Property returning the Parameter object that controls the distance between columns.
HealthStatus Property that returns an enum indicating the current state of the object.
IsPatternElement Property that indicates whether this occurrence pattern is itself an element of a parent pattern. In the case where this occurrence pattern represents a pattern element, this property returns True. The PatternElement property can be used to get that pattern element.
Name Gets/Sets the name for the pattern.
OccurrencePatternElement Property returning a specific element within a pattern. The pattern element returned for row 1, column 1 will contain the components that were provided as input for the pattern.
OccurrencePatternElements Property returning an OccurrencePatternElements collection object. The first element within this collection will contain the components that were provided as input for the pattern.
Parent Property that returns the parent of the object.
ParentComponents Property that gets and sets the components used as input for the pattern.
PatternElement Property that returns the pattern element this occurrence pattern represents. In the case where this occurrence pattern is not part of a parent pattern this property returns Nothing. The IsPatternElement property can be used to check if this occurrence pattern is part of a parent pattern.
RowCount Property returning the Parameter object that controls the number of rows.
RowEntity Gets/Sets the entity used to define the row (x) direction of the pattern.
RowEntityNaturalDirection Gets/Sets whether the row direction is in the natural direction of the row entity or not.
RowOffset Property returning the Parameter object that controls the distance between rows.
Suppressed Returns the suppress state of the occurrence pattern.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets/Sets the Visible property for the pattern.

Accessed From

OccurrencePatterns.AddRectangularPattern, RectangularOccurrencePatternProxy.NativeObject

Derived Classes

RectangularOccurrencePatternProxy

Version

Introduced in version 6

Was this information helpful?