BaseOrdinateDimensionBuilder Class¶
-
class
NXOpen.Annotations.
BaseOrdinateDimensionBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Annotations.OrdinateDimension
builderThis is an abstract class and cannot be instantiated.
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
ActiveHorizontalMargin | Returns or sets the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed. |
ActiveVerticalMargin | Returns or sets the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed. |
AllowDuplicates | Returns or sets the allow duplicates |
AppendedText | Returns the appended text |
AutoAssociativities | Returns the auto ordinate associativities |
Baseline | Returns the baseline |
HorizontalInferredMarginLocation | Returns or sets the horizontal inferred margin location |
Inherit | Returns the inherit |
OrdinateOrigin | Returns the ordinate origin |
Origin | Returns the origin |
RespositionExisting | Returns or sets the resposition existing |
SecondAssociativities | Returns the second associativities |
Style | Returns the style |
Tag | Returns the Tag for this object. |
Type | Returns or sets the type |
VerticalInferredMarginLocation | Returns or sets the vertical inferred margin location |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
BaseOrdinateDimensionBuilderTypes Enumeration | the type of dimension being created |
Property Detail¶
ActiveHorizontalMargin¶
-
BaseOrdinateDimensionBuilder.
ActiveHorizontalMargin
¶ Returns or sets the active horizontal margin(defined or inferred) where horizontal dimension will be automatically placed.
A margin can be created using
NXOpen.Annotations.OrdinateMarginCollection
. If None, must set a HorizontalInferredMarginLocation which will be used to place dimension-------------------------------------
Getter Method
Signature
ActiveHorizontalMargin()
Returns: Return type: NXOpen.Annotations.OrdinateMargin
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActiveHorizontalMargin(margin)
Parameters: margin ( NXOpen.Annotations.OrdinateMargin
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ActiveVerticalMargin¶
-
BaseOrdinateDimensionBuilder.
ActiveVerticalMargin
¶ Returns or sets the active vertical margin(defined or inferred) where horizontal dimension will be automatically placed.
A margin can be created using
NXOpen.Annotations.OrdinateMarginCollection
. If None, must set a VerticalInferredMarginLocation which will be used to place dimension-------------------------------------
Getter Method
Signature
ActiveVerticalMargin()
Returns: Return type: NXOpen.Annotations.OrdinateMargin
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ActiveVerticalMargin(margin)
Parameters: margin ( NXOpen.Annotations.OrdinateMargin
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
AllowDuplicates¶
-
BaseOrdinateDimensionBuilder.
AllowDuplicates
¶ Returns or sets the allow duplicates
-------------------------------------
Getter Method
Signature
AllowDuplicates()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowDuplicates(allowDuplicates)
Parameters: allowDuplicates (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
AppendedText¶
-
BaseOrdinateDimensionBuilder.
AppendedText
¶ Returns the appended text
-------------------------------------
Getter Method
Signature
AppendedText()
Returns: Return type: NXOpen.Annotations.AppendedTextBuilder
New in version NX9.0.0.
License requirements: None.
AutoAssociativities¶
-
BaseOrdinateDimensionBuilder.
AutoAssociativities
¶ Returns the auto ordinate associativities
-------------------------------------
Getter Method
Signature
AutoAssociativities()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX9.0.0.
License requirements: None.
Baseline¶
-
BaseOrdinateDimensionBuilder.
Baseline
¶ Returns the baseline
-------------------------------------
Getter Method
Signature
Baseline()
Returns: Return type: NXOpen.Annotations.OrdinateBaselineBuilder
New in version NX9.0.0.
License requirements: None.
HorizontalInferredMarginLocation¶
-
BaseOrdinateDimensionBuilder.
HorizontalInferredMarginLocation
¶ Returns or sets the horizontal inferred margin location
-------------------------------------
Getter Method
Signature
HorizontalInferredMarginLocation()
Returns: Return type: NXOpen.Point3d
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalInferredMarginLocation(location)
Parameters: location ( NXOpen.Point3d
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Inherit¶
-
BaseOrdinateDimensionBuilder.
Inherit
¶ Returns the inherit
-------------------------------------
Getter Method
Signature
Inherit()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX9.0.0.
License requirements: None.
OrdinateOrigin¶
-
BaseOrdinateDimensionBuilder.
OrdinateOrigin
¶ Returns the ordinate origin
-------------------------------------
Getter Method
Signature
OrdinateOrigin()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX9.0.0.
License requirements: None.
Origin¶
-
BaseOrdinateDimensionBuilder.
Origin
¶ Returns the origin
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX9.0.0.
License requirements: None.
RespositionExisting¶
-
BaseOrdinateDimensionBuilder.
RespositionExisting
¶ Returns or sets the resposition existing
-------------------------------------
Getter Method
Signature
RespositionExisting()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RespositionExisting(respositionExisting)
Parameters: respositionExisting (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
SecondAssociativities¶
-
BaseOrdinateDimensionBuilder.
SecondAssociativities
¶ Returns the second associativities
-------------------------------------
Getter Method
Signature
SecondAssociativities()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX9.0.0.
License requirements: None.
Style¶
-
BaseOrdinateDimensionBuilder.
Style
¶ Returns the style
-------------------------------------
Getter Method
Signature
Style()
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX9.0.0.
License requirements: None.
Type¶
-
BaseOrdinateDimensionBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Annotations.BaseOrdinateDimensionBuilderTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Annotations.BaseOrdinateDimensionBuilderTypes
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
VerticalInferredMarginLocation¶
-
BaseOrdinateDimensionBuilder.
VerticalInferredMarginLocation
¶ Returns or sets the vertical inferred margin location
-------------------------------------
Getter Method
Signature
VerticalInferredMarginLocation()
Returns: Return type: NXOpen.Point3d
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalInferredMarginLocation(location)
Parameters: location ( NXOpen.Point3d
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
BaseOrdinateDimensionBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.