UnitsFormatPreferences (NXOpen Java API Reference)

All Superinterfaces:

Remote, TransientObject
```
public interface UnitsFormatPreferences
extends TransientObject
```
Represents units and format preferences .
Created in NX4.0.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AngularDimensionFormat`	`angularDimensionFormat()` Returns the angular dimension format License requirements: None.
`AngularDimensionFormat`	`angularToleranceFormat()` Returns the angular tolerance format License requirements: None.
`boolean`	`convertPrimaryToleranceToDualDimensionUnit()` Returns the flag indicating whether to convert the primary tolerance to dual dimension unit License requirements: None.
`DecimalPointCharacter`	`decimalPointCharacter()` Returns the decimal point character License requirements: None.
`boolean`	`dimensionLeadingZero()` Returns the dimension leading zero display property License requirements: None.
`boolean`	`displayTrailingZeros()` Returns the flag indicating whether to display trailing zeros on dimension values License requirements: None.
`DualDimensionPlacement`	`dualDimensionPlacement()` Returns the dual dimension placement relative to the primary dimension License requirements: None.
`DimensionTextFormat`	`dualDimensionTextFormat()` Returns the dual dimension text format License requirements: None.
`DimensionUnit`	`dualDimensionUnit()` Returns the dual dimension unit License requirements: None.
`boolean`	`fractionalDisplay()` Returns the fractional display for angular dimension License requirements: None.
`int`	`numeratorDegrees()` Returns the numerator degrees of fractional display for angular dimension License requirements: None.
`double`	`numeratorFraction()` Returns the numerator fractional degrees of fractional display for angular dimension License requirements: None.
`int`	`numeratorMinutes()` Returns the numerator minutes of fractional display for angular dimension License requirements: None.
`int`	`numeratorSeconds()` Returns the numerator seconds of fractional display for angular dimension License requirements: None.
`DimensionTextFormat`	`primaryDimensionTextFormat()` Returns the primary dimension text format License requirements: None.
`DimensionUnit`	`primaryDimensionUnit()` Returns the primary dimension unit License requirements: None.
`void`	`setAngularDimensionFormat(AngularDimensionFormat format)` Sets the angular dimension format License requirements: None.
`void`	`setAngularToleranceFormat(AngularDimensionFormat format)` Sets the angular tolerance format License requirements: None.
`void`	`setConvertPrimaryToleranceToDualDimensionUnit(boolean convertPrimaryToleranceToDualUnit)` Sets the flag indicating whether to convert the primary tolerance to dual dimension unit License requirements: None.
`void`	`setDecimalPointCharacter(DecimalPointCharacter decimalPointCharacter)` Sets the decimal point character License requirements: None.
`void`	`setDimensionLeadingZero(boolean dimensionLeadingZero)` Sets the dimension leading zero display property License requirements: None.
`void`	`setDisplayTrailingZeros(boolean displayTrailingZeros)` Sets the flag indicating whether to display trailing zeros on dimension values License requirements: None.
`void`	`setDualDimensionPlacement(DualDimensionPlacement placement)` Sets the dual dimension placement relative to the primary dimension License requirements: None.
`void`	`setDualDimensionTextFormat(DimensionTextFormat textFormat)` Sets the dual dimension text format License requirements: None.
`void`	`setDualDimensionUnit(DimensionUnit unit)` Sets the dual dimension unit License requirements: None.
`void`	`setFractionalDisplay(boolean fractionalDisplay)` License requirements: None.
`void`	`setNumeratorDegrees(int numeratorDegrees)` License requirements: None.
`void`	`setNumeratorFraction(double numeratorFraction)` License requirements: None.
`void`	`setNumeratorMinutes(int numeratorMinutes)` License requirements: None.
`void`	`setNumeratorSeconds(int numeratorSeconds)` License requirements: None.
`void`	`setPrimaryDimensionTextFormat(DimensionTextFormat textFormat)` Sets the primary dimension text format License requirements: None.
`void`	`setPrimaryDimensionUnit(DimensionUnit unit)` Sets the primary dimension unit License requirements: None.
`void`	`setSuppressAngularZerosOption(AngularSuppressZeros option)` Sets the angular dimension suppress zeros option License requirements: None.
`void`	`setToleranceLeadingZero(boolean toleranceLeadingZero)` Sets the tolerance leading zero display property License requirements: None.
`void`	`setTolerancePlacement(TolerancePlacement placement)` Sets the tolerance text placement relative to the dimension text License requirements: None.
`AngularSuppressZeros`	`suppressAngularZerosOption()` Returns the angular dimension suppress zeros option License requirements: None.
`boolean`	`toleranceLeadingZero()` Returns the tolerance leading zero display property License requirements: None.
`TolerancePlacement`	`tolerancePlacement()` Returns the tolerance text placement relative to the dimension text License requirements: None.

Methods inherited from interface nxopen.TransientObject
_value, dispose, printTestData, printTestData

Method Detail

primaryDimensionUnit

DimensionUnit primaryDimensionUnit()
                            throws NXException,
                                   RemoteException

Returns the primary dimension unit
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setPrimaryDimensionUnit

void setPrimaryDimensionUnit(DimensionUnit unit)
                      throws NXException,
                             RemoteException

Sets the primary dimension unit
License requirements: None.

Created in NX4.0.0

Parameters:: unit -
Throws:: NXException; RemoteException

primaryDimensionTextFormat

DimensionTextFormat primaryDimensionTextFormat()
                                        throws NXException,
                                               RemoteException

Returns the primary dimension text format
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setPrimaryDimensionTextFormat

void setPrimaryDimensionTextFormat(DimensionTextFormat textFormat)
                            throws NXException,
                                   RemoteException

Sets the primary dimension text format
License requirements: None.

Created in NX4.0.0

Parameters:: textFormat -
Throws:: NXException; RemoteException

decimalPointCharacter

DecimalPointCharacter decimalPointCharacter()
                                     throws NXException,
                                            RemoteException

Returns the decimal point character
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setDecimalPointCharacter

void setDecimalPointCharacter(DecimalPointCharacter decimalPointCharacter)
                       throws NXException,
                              RemoteException

Sets the decimal point character
License requirements: None.

Created in NX4.0.0

Parameters:: decimalPointCharacter -
Throws:: NXException; RemoteException

displayTrailingZeros
```
boolean displayTrailingZeros()
                      throws NXException,
                             RemoteException
```
Returns the flag indicating whether to display trailing zeros on dimension values
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setDisplayTrailingZeros
```
void setDisplayTrailingZeros(boolean displayTrailingZeros)
                      throws NXException,
                             RemoteException
```
Sets the flag indicating whether to display trailing zeros on dimension values
License requirements: None.

Created in NX4.0.0

Parameters:

displayTrailingZeros -

Throws:

NXException

RemoteException

tolerancePlacement

TolerancePlacement tolerancePlacement()
                               throws NXException,
                                      RemoteException

Returns the tolerance text placement relative to the dimension text
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setTolerancePlacement
```
void setTolerancePlacement(TolerancePlacement placement)
                    throws NXException,
                           RemoteException
```
Sets the tolerance text placement relative to the dimension text
License requirements: None.

Created in NX4.0.0

Parameters:

placement -

Throws:

NXException

RemoteException

angularDimensionFormat

AngularDimensionFormat angularDimensionFormat()
                                       throws NXException,
                                              RemoteException

Returns the angular dimension format
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setAngularDimensionFormat

void setAngularDimensionFormat(AngularDimensionFormat format)
                        throws NXException,
                               RemoteException

Sets the angular dimension format
License requirements: None.

Created in NX4.0.0

Parameters:: format -
Throws:: NXException; RemoteException

angularToleranceFormat

AngularDimensionFormat angularToleranceFormat()
                                       throws NXException,
                                              RemoteException

Returns the angular tolerance format
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setAngularToleranceFormat

void setAngularToleranceFormat(AngularDimensionFormat format)
                        throws NXException,
                               RemoteException

Sets the angular tolerance format
License requirements: None.

Created in NX4.0.0

Parameters:: format -
Throws:: NXException; RemoteException

dualDimensionPlacement

DualDimensionPlacement dualDimensionPlacement()
                                       throws NXException,
                                              RemoteException

Returns the dual dimension placement relative to the primary dimension
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setDualDimensionPlacement

void setDualDimensionPlacement(DualDimensionPlacement placement)
                        throws NXException,
                               RemoteException

Sets the dual dimension placement relative to the primary dimension
License requirements: None.

Created in NX4.0.0

Parameters:: placement -
Throws:: NXException; RemoteException

dualDimensionUnit

DimensionUnit dualDimensionUnit()
                         throws NXException,
                                RemoteException

Returns the dual dimension unit
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setDualDimensionUnit

void setDualDimensionUnit(DimensionUnit unit)
                   throws NXException,
                          RemoteException

Sets the dual dimension unit
License requirements: None.

Created in NX4.0.0

Parameters:: unit -
Throws:: NXException; RemoteException

dualDimensionTextFormat

DimensionTextFormat dualDimensionTextFormat()
                                     throws NXException,
                                            RemoteException

Returns the dual dimension text format
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setDualDimensionTextFormat

void setDualDimensionTextFormat(DimensionTextFormat textFormat)
                         throws NXException,
                                RemoteException

Sets the dual dimension text format
License requirements: None.

Created in NX4.0.0

Parameters:: textFormat -
Throws:: NXException; RemoteException

convertPrimaryToleranceToDualDimensionUnit

boolean convertPrimaryToleranceToDualDimensionUnit()
                                            throws NXException,
                                                   RemoteException

Returns the flag indicating whether to convert the primary tolerance to dual dimension unit
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setConvertPrimaryToleranceToDualDimensionUnit

void setConvertPrimaryToleranceToDualDimensionUnit(boolean convertPrimaryToleranceToDualUnit)
                                            throws NXException,
                                                   RemoteException

Sets the flag indicating whether to convert the primary tolerance to dual dimension unit
License requirements: None.

Created in NX4.0.0

Parameters:: convertPrimaryToleranceToDualUnit -
Throws:: NXException; RemoteException

suppressAngularZerosOption

AngularSuppressZeros suppressAngularZerosOption()
                                         throws NXException,
                                                RemoteException

Returns the angular dimension suppress zeros option
License requirements: None.

Created in NX4.0.0

Throws:: NXException; RemoteException

setSuppressAngularZerosOption

void setSuppressAngularZerosOption(AngularSuppressZeros option)
                            throws NXException,
                                   RemoteException

Sets the angular dimension suppress zeros option
License requirements: None.

Created in NX4.0.0

Parameters:: option -
Throws:: NXException; RemoteException

dimensionLeadingZero
```
boolean dimensionLeadingZero()
                      throws NXException,
                             RemoteException
```
Returns the dimension leading zero display property
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setDimensionLeadingZero
```
void setDimensionLeadingZero(boolean dimensionLeadingZero)
                      throws NXException,
                             RemoteException
```
Sets the dimension leading zero display property
License requirements: None.

Created in NX5.0.0

Parameters:

dimensionLeadingZero -

Throws:

NXException

RemoteException

toleranceLeadingZero
```
boolean toleranceLeadingZero()
                      throws NXException,
                             RemoteException
```
Returns the tolerance leading zero display property
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setToleranceLeadingZero
```
void setToleranceLeadingZero(boolean toleranceLeadingZero)
                      throws NXException,
                             RemoteException
```
Sets the tolerance leading zero display property
License requirements: None.

Created in NX5.0.0

Parameters:

toleranceLeadingZero -

Throws:

NXException

RemoteException

fractionalDisplay
```
boolean fractionalDisplay()
                   throws NXException,
                          RemoteException
```
Returns the fractional display for angular dimension
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException