UnitsFormatPreferences Class — NXOpen Python API Reference 12.0.0 documentation

# UnitsFormatPreferences Class

class `NXOpen.Annotations.``UnitsFormatPreferences`

  Bases: `NXOpen.TransientObject`

  Represents units and format preferences

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
AngularDimensionFormat | Returns or sets the angular dimension format
AngularToleranceFormat | Returns or sets the angular tolerance format
ConvertPrimaryToleranceToDualDimensionUnit | Returns or sets the flag indicating whether to convert the primary tolerance to dual dimension unit
DecimalPointCharacter | Returns or sets the decimal point character
DimensionLeadingZero | Returns or sets the dimension leading zero display property
DisplayTrailingZeros | Returns or sets the flag indicating whether to display trailing zeros on dimension values
DualDimensionCenterDimensionLine | Returns or sets the center dimension line flag for dual dimension.
DualDimensionPlacement | Returns or sets the dual dimension placement relative to the primary dimension
DualDimensionTextFormat | Returns or sets the dual dimension text format
DualDimensionUnit | Returns or sets the dual dimension unit
FractionalDisplay | Returns or sets the fractional display for angular dimension
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
PrimaryDimensionTextFormat | Returns or sets the primary dimension text format
PrimaryDimensionUnit | Returns or sets the primary dimension unit
SuppressAngularZerosOption | Returns or sets the angular dimension suppress zeros option
ToleranceLeadingZero | Returns or sets the tolerance leading zero display property
TolerancePlacement | Returns or sets the tolerance text placement relative to the dimension text

# Methods

Method | Description
--- | ---
Dispose | Frees the object from memory.

# Property Detail

## AngularDimensionFormat

`UnitsFormatPreferences.``AngularDimensionFormat`

  Returns or sets the angular dimension format

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

  Getter Method

  Signature `AngularDimensionFormat`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularDimensionFormat`

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

  New in version NX4.0.0.

  License requirements: None.

## AngularToleranceFormat

`UnitsFormatPreferences.``AngularToleranceFormat`

  Returns or sets the angular tolerance format

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

  Getter Method

  Signature `AngularToleranceFormat`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AngularToleranceFormat`

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

  New in version NX4.0.0.

  License requirements: None.

## ConvertPrimaryToleranceToDualDimensionUnit

`UnitsFormatPreferences.``ConvertPrimaryToleranceToDualDimensionUnit`

  Returns or sets the flag indicating whether to convert the primary tolerance to dual dimension unit

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

  Getter Method

  Signature `ConvertPrimaryToleranceToDualDimensionUnit`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ConvertPrimaryToleranceToDualDimensionUnit`

  Parameters: | convertPrimaryToleranceToDualUnit (bool) –

  New in version NX4.0.0.

  License requirements: None.

## DecimalPointCharacter

`UnitsFormatPreferences.``DecimalPointCharacter`

  Returns or sets the decimal point character

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

  Getter Method

  Signature `DecimalPointCharacter`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DecimalPointCharacter`

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

  New in version NX4.0.0.

  License requirements: None.

## DimensionLeadingZero

`UnitsFormatPreferences.``DimensionLeadingZero`

  Returns or sets the dimension leading zero display property

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

  Getter Method

  Signature `DimensionLeadingZero`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DimensionLeadingZero`

  Parameters: | dimensionLeadingZero (bool) –

  New in version NX5.0.0.

  License requirements: None.

## DisplayTrailingZeros

`UnitsFormatPreferences.``DisplayTrailingZeros`

  Returns or sets the flag indicating whether to display trailing zeros on dimension values

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

  Getter Method

  Signature `DisplayTrailingZeros`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DisplayTrailingZeros`

  Parameters: | displayTrailingZeros (bool) –

  New in version NX4.0.0.

  License requirements: None.

## DualDimensionCenterDimensionLine

`UnitsFormatPreferences.``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: None.

## DualDimensionPlacement

`UnitsFormatPreferences.``DualDimensionPlacement`

  Returns or sets the dual dimension placement relative to the primary dimension

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

  Getter Method

  Signature `DualDimensionPlacement`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DualDimensionPlacement`

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

  New in version NX4.0.0.

  License requirements: None.

## DualDimensionTextFormat

`UnitsFormatPreferences.``DualDimensionTextFormat`

  Returns or sets the dual dimension text format

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

  Getter Method

  Signature `DualDimensionTextFormat`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DualDimensionTextFormat`

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

  New in version NX4.0.0.

  License requirements: None.

## DualDimensionUnit

`UnitsFormatPreferences.``DualDimensionUnit`

  Returns or sets the dual dimension unit

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

  Getter Method

  Signature `DualDimensionUnit`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DualDimensionUnit`

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

  New in version NX4.0.0.

  License requirements: None.

## FractionalDisplay

`UnitsFormatPreferences.``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: None.

## NumeratorDegrees

`UnitsFormatPreferences.``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: None.

## NumeratorFraction

`UnitsFormatPreferences.``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: None.

## NumeratorMinutes

`UnitsFormatPreferences.``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: None.

## NumeratorSeconds

`UnitsFormatPreferences.``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: None.

## PrimaryDimensionTextFormat

`UnitsFormatPreferences.``PrimaryDimensionTextFormat`

  Returns or sets the primary dimension text format

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

  Getter Method

  Signature `PrimaryDimensionTextFormat`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PrimaryDimensionTextFormat`

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

  New in version NX4.0.0.

  License requirements: None.

## PrimaryDimensionUnit

`UnitsFormatPreferences.``PrimaryDimensionUnit`

  Returns or sets the primary dimension unit

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

  Getter Method

  Signature `PrimaryDimensionUnit`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PrimaryDimensionUnit`

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

  New in version NX4.0.0.

  License requirements: None.

## SuppressAngularZerosOption

`UnitsFormatPreferences.``SuppressAngularZerosOption`

  Returns or sets the angular dimension suppress zeros option

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

  Getter Method

  Signature `SuppressAngularZerosOption`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SuppressAngularZerosOption`

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

  New in version NX4.0.0.

  License requirements: None.

## ToleranceLeadingZero

`UnitsFormatPreferences.``ToleranceLeadingZero`

  Returns or sets the tolerance leading zero display property

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

  Getter Method

  Signature `ToleranceLeadingZero`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ToleranceLeadingZero`

  Parameters: | toleranceLeadingZero (bool) –

  New in version NX5.0.0.

  License requirements: None.

## TolerancePlacement

`UnitsFormatPreferences.``TolerancePlacement`

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

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

  Getter Method

  Signature `TolerancePlacement`

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

  New in version NX4.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TolerancePlacement`

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

  New in version NX4.0.0.

  License requirements: None.

# Method Detail

## Dispose

`UnitsFormatPreferences.``Dispose`

  Frees the object from memory.

  After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

  Signature `Dispose()`

  New in version NX4.0.0.

  License requirements: None.