UnitsStyleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# UnitsStyleBuilder Class

class `NXOpen.Annotations.``UnitsStyleBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Annotations.UnitsStyleBuilder`.

  This class queries and sets units and format preferences when creating or editing a dimension. .. versionadded:: NX6.0.0

# Properties

Property | Description
--- | ---
AngularSuppressZeros | Returns or sets the angular suppress zeros option
ConvertPrimaryTolerance | Returns or sets the convert primary tolerance option.
DecimalPointCharacter | Returns or sets the decimal point character
DimensionAngularFormat | Returns or sets the dimension angular format and precision
DimensionLinearUnits | Returns or sets the dimension linear units
DimensionTolerancePlacement | Returns or sets the dimension tolerance placement relative to the dimension value
DisplayLeadingDimensionZeros | Returns or sets the display leading dimension zeros setting for linear dimensions and fractional angular dimensions
DisplayLeadingToleranceZeros | Returns or sets the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions
DisplayTrailingZeros | Returns or sets the display trailing zeros setting for linear dimensions and tolerances
DualDimensionCenterDimensionLine | Returns or sets the center dimension line flag for dual dimension.
DualDimensionFormat | Returns or sets the dual dimension format.
DualDimensionUnits | Returns or sets the dual dimension units
DualFractionType | Returns or sets the decimal and fraction format for dual nonmetric dimensions
FractionalDisplay | Returns or sets the fractional display for angular dimension
LinearFractionType | Returns or sets the decimal and fraction text format for nonmetric dimensions
NumeratorDegrees | Returns or sets the numerator degrees of fractional display for angular dimension
NumeratorFraction | Returns or sets the numerator fractional degrees of fractional display for angular dimension
NumeratorMinutes | Returns or sets the numerator minutes of fractional display for angular dimension
NumeratorSeconds | Returns or sets the numerator seconds of fractional display for angular dimension
Tag | Returns the Tag for this object.
ToleranceAngularFormat | Returns or sets the tolerance angular format and precision

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AngularSuppressZeros

`UnitsStyleBuilder.``AngularSuppressZeros`

  Returns or sets the angular suppress zeros option

  `-------------------------------------`

  Getter Method

  Signature `AngularSuppressZeros`

  Returns: |
  Return type: | `NXOpen.Annotations.AngularSuppressZeros`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AngularSuppressZeros`

  Parameters: | angularSuppressZeros (`NXOpen.Annotations.AngularSuppressZeros`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## ConvertPrimaryTolerance

`UnitsStyleBuilder.``ConvertPrimaryTolerance`

  Returns or sets the convert primary tolerance option.

  A value of True means that the dual dimension tolerance is automatically set by converting the primary dimension tolerance value to the dual dimension units

  `-------------------------------------`

  Getter Method

  Signature `ConvertPrimaryTolerance`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ConvertPrimaryTolerance`

  Parameters: | convertPrimaryTolerance (bool) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DecimalPointCharacter

`UnitsStyleBuilder.``DecimalPointCharacter`

  Returns or sets the decimal point character

  `-------------------------------------`

  Getter Method

  Signature `DecimalPointCharacter`

  Returns: |
  Return type: | `NXOpen.Annotations.DecimalPointCharacter`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DecimalPointCharacter`

  Parameters: | decimalPointCharacter (`NXOpen.Annotations.DecimalPointCharacter`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DimensionAngularFormat

`UnitsStyleBuilder.``DimensionAngularFormat`

  Returns or sets the dimension angular format and precision

  `-------------------------------------`

  Getter Method

  Signature `DimensionAngularFormat`

  Returns: |
  Return type: | `NXOpen.Annotations.AngularDimensionFormat`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DimensionAngularFormat`

  Parameters: | dimensionAngularFormat (`NXOpen.Annotations.AngularDimensionFormat`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DimensionLinearUnits

`UnitsStyleBuilder.``DimensionLinearUnits`

  Returns or sets the dimension linear units

  `-------------------------------------`

  Getter Method

  Signature `DimensionLinearUnits`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionUnit`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DimensionLinearUnits`

  Parameters: | dimensionLinearUnits (`NXOpen.Annotations.DimensionUnit`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DimensionTolerancePlacement

`UnitsStyleBuilder.``DimensionTolerancePlacement`

  Returns or sets the dimension tolerance placement relative to the dimension value

  `-------------------------------------`

  Getter Method

  Signature `DimensionTolerancePlacement`

  Returns: |
  Return type: | `NXOpen.Annotations.TolerancePlacement`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DimensionTolerancePlacement`

  Parameters: | dimensionTolerancePlacement (`NXOpen.Annotations.TolerancePlacement`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DisplayLeadingDimensionZeros

`UnitsStyleBuilder.``DisplayLeadingDimensionZeros`

  Returns or sets the display leading dimension zeros setting for linear dimensions and fractional angular dimensions

  `-------------------------------------`

  Getter Method

  Signature `DisplayLeadingDimensionZeros`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayLeadingDimensionZeros`

  Parameters: | displayLeadingDimensionZeros (bool) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DisplayLeadingToleranceZeros

`UnitsStyleBuilder.``DisplayLeadingToleranceZeros`

  Returns or sets the display leading tolerance zeros setting for linear dimensions and fractional angular dimensions

  `-------------------------------------`

  Getter Method

  Signature `DisplayLeadingToleranceZeros`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayLeadingToleranceZeros`

  Parameters: | displayLeadingToleranceZeros (bool) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DisplayTrailingZeros

`UnitsStyleBuilder.``DisplayTrailingZeros`

  Returns or sets the display trailing zeros setting for linear dimensions and tolerances

  `-------------------------------------`

  Getter Method

  Signature `DisplayTrailingZeros`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayTrailingZeros`

  Parameters: | displayTrailingZeros (bool) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DualDimensionCenterDimensionLine

`UnitsStyleBuilder.``DualDimensionCenterDimensionLine`

  Returns or sets the center dimension line flag for dual dimension.

  If this flag is true, the alignment of the dimension line will be centered between the main and dual text, regardless of appended text above or below and the Vertical Alignment of the leader line.

  `-------------------------------------`

  Getter Method

  Signature `DualDimensionCenterDimensionLine`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DualDimensionCenterDimensionLine`

  Parameters: | centerDimensionLine (bool) –

  New in version NX12.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DualDimensionFormat

`UnitsStyleBuilder.``DualDimensionFormat`

  Returns or sets the dual dimension format.

  This specifies both the creation and position of the dual dimension

  `-------------------------------------`

  Getter Method

  Signature `DualDimensionFormat`

  Returns: |
  Return type: | `NXOpen.Annotations.DualDimensionPlacement`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DualDimensionFormat`

  Parameters: | dualDimensionFormat (`NXOpen.Annotations.DualDimensionPlacement`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DualDimensionUnits

`UnitsStyleBuilder.``DualDimensionUnits`

  Returns or sets the dual dimension units

  `-------------------------------------`

  Getter Method

  Signature `DualDimensionUnits`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionUnit`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DualDimensionUnits`

  Parameters: | dualDimensionUnits (`NXOpen.Annotations.DimensionUnit`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## DualFractionType

`UnitsStyleBuilder.``DualFractionType`

  Returns or sets the decimal and fraction format for dual nonmetric dimensions

  `-------------------------------------`

  Getter Method

  Signature `DualFractionType`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionTextFormat`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DualFractionType`

  Parameters: | dualFractionType (`NXOpen.Annotations.DimensionTextFormat`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## FractionalDisplay

`UnitsStyleBuilder.``FractionalDisplay`

  Returns or sets the fractional display for angular dimension

  `-------------------------------------`

  Getter Method

  Signature `FractionalDisplay`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FractionalDisplay`

  Parameters: | fractionalDisplay (bool) –

  New in version NX8.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## LinearFractionType

`UnitsStyleBuilder.``LinearFractionType`

  Returns or sets the decimal and fraction text format for nonmetric dimensions

  `-------------------------------------`

  Getter Method

  Signature `LinearFractionType`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionTextFormat`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LinearFractionType`

  Parameters: | linearFractionType (`NXOpen.Annotations.DimensionTextFormat`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## NumeratorDegrees

`UnitsStyleBuilder.``NumeratorDegrees`

  Returns or sets the numerator degrees of fractional display for angular dimension

  `-------------------------------------`

  Getter Method

  Signature `NumeratorDegrees`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumeratorDegrees`

  Parameters: | numeratorDegrees (int) –

  New in version NX8.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## NumeratorFraction

`UnitsStyleBuilder.``NumeratorFraction`

  Returns or sets the numerator fractional degrees of fractional display for angular dimension

  `-------------------------------------`

  Getter Method

  Signature `NumeratorFraction`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumeratorFraction`

  Parameters: | numeratorFraction (float) –

  New in version NX8.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## NumeratorMinutes

`UnitsStyleBuilder.``NumeratorMinutes`

  Returns or sets the numerator minutes of fractional display for angular dimension

  `-------------------------------------`

  Getter Method

  Signature `NumeratorMinutes`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumeratorMinutes`

  Parameters: | numeratorMinutes (int) –

  New in version NX8.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## NumeratorSeconds

`UnitsStyleBuilder.``NumeratorSeconds`

  Returns or sets the numerator seconds of fractional display for angular dimension

  `-------------------------------------`

  Getter Method

  Signature `NumeratorSeconds`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumeratorSeconds`

  Parameters: | numeratorSeconds (int) –

  New in version NX8.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

## ToleranceAngularFormat

`UnitsStyleBuilder.``ToleranceAngularFormat`

  Returns or sets the tolerance angular format and precision

  `-------------------------------------`

  Getter Method

  Signature `ToleranceAngularFormat`

  Returns: |
  Return type: | `NXOpen.Annotations.AngularDimensionFormat`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ToleranceAngularFormat`

  Parameters: | toleranceAngularFormat (`NXOpen.Annotations.AngularDimensionFormat`) –

  New in version NX6.0.0.

  License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

# Method Detail

## Validate

`UnitsStyleBuilder.``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.