NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::UnitsFormatPreferences Class Reference

Represents units and format preferences
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::UnitsFormatPreferences:
NXOpen::TransientObject

Public Member Functions

NXOpen::Annotations::AngularDimensionFormat AngularDimensionFormat ()
 Returns the angular dimension format
Created in NX4.0.0. More...
 
NXOpen::Annotations::AngularDimensionFormat AngularToleranceFormat ()
 Returns the angular tolerance format
Created in NX4.0.0. More...
 
bool ConvertPrimaryToleranceToDualDimensionUnit ()
 Returns the flag indicating whether to convert the primary tolerance to dual dimension unit
Created in NX4.0.0. More...
 
NXOpen::Annotations::DecimalPointCharacter DecimalPointCharacter ()
 Returns the decimal point character
Created in NX4.0.0. More...
 
bool DimensionLeadingZero ()
 Returns the dimension leading zero display property
Created in NX5.0.0. More...
 
bool DisplayTrailingZeros ()
 Returns the flag indicating whether to display trailing zeros on dimension values
Created in NX4.0.0. More...
 
bool DualDimensionCenterDimensionLine ()
 Returns the center dimension line flag for dual dimension. More...
 
NXOpen::Annotations::DualDimensionPlacement DualDimensionPlacement ()
 Returns the dual dimension placement relative to the primary dimension
Created in NX4.0.0. More...
 
NXOpen::Annotations::DimensionTextFormat DualDimensionTextFormat ()
 Returns the dual dimension text format
Created in NX4.0.0. More...
 
NXOpen::Annotations::DimensionUnit DualDimensionUnit ()
 Returns the dual dimension unit
Created in NX4.0.0. More...
 
bool FractionalDisplay ()
 Returns the fractional display for angular dimension
Created in NX8.0.0. More...
 
int NumeratorDegrees ()
 Returns the numerator degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
double NumeratorFraction ()
 Returns the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
int NumeratorMinutes ()
 Returns the numerator minutes of fractional display for angular dimension
Created in NX8.0.0. More...
 
int NumeratorSeconds ()
 Returns the numerator seconds of fractional display for angular dimension
Created in NX8.0.0. More...
 
NXOpen::Annotations::DimensionTextFormat PrimaryDimensionTextFormat ()
 Returns the primary dimension text format
Created in NX4.0.0. More...
 
NXOpen::Annotations::DimensionUnit PrimaryDimensionUnit ()
 Returns the primary dimension unit
Created in NX4.0.0. More...
 
void SetAngularDimensionFormat (NXOpen::Annotations::AngularDimensionFormat format)
 Sets the angular dimension format
Created in NX4.0.0. More...
 
void SetAngularToleranceFormat (NXOpen::Annotations::AngularDimensionFormat format)
 Sets the angular tolerance format
Created in NX4.0.0. More...
 
void SetConvertPrimaryToleranceToDualDimensionUnit (bool convertPrimaryToleranceToDualUnit)
 Sets the flag indicating whether to convert the primary tolerance to dual dimension unit
Created in NX4.0.0. More...
 
void SetDecimalPointCharacter (NXOpen::Annotations::DecimalPointCharacter decimalPointCharacter)
 Sets the decimal point character
Created in NX4.0.0. More...
 
void SetDimensionLeadingZero (bool dimensionLeadingZero)
 Sets the dimension leading zero display property
Created in NX5.0.0. More...
 
void SetDisplayTrailingZeros (bool displayTrailingZeros)
 Sets the flag indicating whether to display trailing zeros on dimension values
Created in NX4.0.0. More...
 
void SetDualDimensionCenterDimensionLine (bool centerDimensionLine)
 Sets the center dimension line flag for dual dimension. More...
 
void SetDualDimensionPlacement (NXOpen::Annotations::DualDimensionPlacement placement)
 Sets the dual dimension placement relative to the primary dimension
Created in NX4.0.0. More...
 
void SetDualDimensionTextFormat (NXOpen::Annotations::DimensionTextFormat textFormat)
 Sets the dual dimension text format
Created in NX4.0.0. More...
 
void SetDualDimensionUnit (NXOpen::Annotations::DimensionUnit unit)
 Sets the dual dimension unit
Created in NX4.0.0. More...
 
void SetFractionalDisplay (bool fractionalDisplay)
 Sets the fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorDegrees (int numeratorDegrees)
 Sets the numerator degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorFraction (double numeratorFraction)
 Sets the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorMinutes (int numeratorMinutes)
 Sets the numerator minutes of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetNumeratorSeconds (int numeratorSeconds)
 Sets the numerator seconds of fractional display for angular dimension
Created in NX8.0.0. More...
 
void SetPrimaryDimensionTextFormat (NXOpen::Annotations::DimensionTextFormat textFormat)
 Sets the primary dimension text format
Created in NX4.0.0. More...
 
void SetPrimaryDimensionUnit (NXOpen::Annotations::DimensionUnit unit)
 Sets the primary dimension unit
Created in NX4.0.0. More...
 
void SetSuppressAngularZerosOption (NXOpen::Annotations::AngularSuppressZeros option)
 Sets the angular dimension suppress zeros option
Created in NX4.0.0. More...
 
void SetToleranceLeadingZero (bool toleranceLeadingZero)
 Sets the tolerance leading zero display property
Created in NX5.0.0. More...
 
void SetTolerancePlacement (NXOpen::Annotations::TolerancePlacement placement)
 Sets the tolerance text placement relative to the dimension text
Created in NX4.0.0. More...
 
NXOpen::Annotations::AngularSuppressZeros SuppressAngularZerosOption ()
 Returns the angular dimension suppress zeros option
Created in NX4.0.0. More...
 
bool ToleranceLeadingZero ()
 Returns the tolerance leading zero display property
Created in NX5.0.0. More...
 
NXOpen::Annotations::TolerancePlacement TolerancePlacement ()
 Returns the tolerance text placement relative to the dimension text
Created in NX4.0.0. More...
 
virtual ~UnitsFormatPreferences ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Represents units and format preferences
Created in NX4.0.0.


Constructor & Destructor Documentation

virtual NXOpen::Annotations::UnitsFormatPreferences::~UnitsFormatPreferences ( )
virtual

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.
Created in NX4.0.0.

License requirements : None

Member Function Documentation

NXOpen::Annotations::AngularDimensionFormat NXOpen::Annotations::UnitsFormatPreferences::AngularDimensionFormat ( )

Returns the angular dimension format
Created in NX4.0.0.



License requirements : None

NXOpen::Annotations::AngularDimensionFormat NXOpen::Annotations::UnitsFormatPreferences::AngularToleranceFormat ( )

Returns the angular tolerance format
Created in NX4.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::ConvertPrimaryToleranceToDualDimensionUnit ( )

Returns the flag indicating whether to convert the primary tolerance to dual dimension unit
Created in NX4.0.0.



License requirements : None

NXOpen::Annotations::DecimalPointCharacter NXOpen::Annotations::UnitsFormatPreferences::DecimalPointCharacter ( )

Returns the decimal point character
Created in NX4.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::DimensionLeadingZero ( )

Returns the dimension leading zero display property
Created in NX5.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::DisplayTrailingZeros ( )

Returns the flag indicating whether to display trailing zeros on dimension values
Created in NX4.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::DualDimensionCenterDimensionLine ( )

Returns 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.
Created in NX12.0.0.

License requirements : None

NXOpen::Annotations::DualDimensionPlacement NXOpen::Annotations::UnitsFormatPreferences::DualDimensionPlacement ( )

Returns the dual dimension placement relative to the primary dimension
Created in NX4.0.0.



License requirements : None

NXOpen::Annotations::DimensionTextFormat NXOpen::Annotations::UnitsFormatPreferences::DualDimensionTextFormat ( )

Returns the dual dimension text format
Created in NX4.0.0.



License requirements : None

NXOpen::Annotations::DimensionUnit NXOpen::Annotations::UnitsFormatPreferences::DualDimensionUnit ( )

Returns the dual dimension unit
Created in NX4.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::FractionalDisplay ( )

Returns the fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::UnitsFormatPreferences::NumeratorDegrees ( )

Returns the numerator degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

double NXOpen::Annotations::UnitsFormatPreferences::NumeratorFraction ( )

Returns the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::UnitsFormatPreferences::NumeratorMinutes ( )

Returns the numerator minutes of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

int NXOpen::Annotations::UnitsFormatPreferences::NumeratorSeconds ( )

Returns the numerator seconds of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

NXOpen::Annotations::DimensionTextFormat NXOpen::Annotations::UnitsFormatPreferences::PrimaryDimensionTextFormat ( )

Returns the primary dimension text format
Created in NX4.0.0.



License requirements : None

NXOpen::Annotations::DimensionUnit NXOpen::Annotations::UnitsFormatPreferences::PrimaryDimensionUnit ( )

Returns the primary dimension unit
Created in NX4.0.0.



License requirements : None

void NXOpen::Annotations::UnitsFormatPreferences::SetAngularDimensionFormat ( NXOpen::Annotations::AngularDimensionFormat  format)

Sets the angular dimension format
Created in NX4.0.0.



License requirements : None

Parameters
formatformat
void NXOpen::Annotations::UnitsFormatPreferences::SetAngularToleranceFormat ( NXOpen::Annotations::AngularDimensionFormat  format)

Sets the angular tolerance format
Created in NX4.0.0.



License requirements : None

Parameters
formatformat
void NXOpen::Annotations::UnitsFormatPreferences::SetConvertPrimaryToleranceToDualDimensionUnit ( bool  convertPrimaryToleranceToDualUnit)

Sets the flag indicating whether to convert the primary tolerance to dual dimension unit
Created in NX4.0.0.



License requirements : None

Parameters
convertPrimaryToleranceToDualUnitconvert primary tolerance to dual unit
void NXOpen::Annotations::UnitsFormatPreferences::SetDecimalPointCharacter ( NXOpen::Annotations::DecimalPointCharacter  decimalPointCharacter)

Sets the decimal point character
Created in NX4.0.0.



License requirements : None

Parameters
decimalPointCharacterdecimal point character
void NXOpen::Annotations::UnitsFormatPreferences::SetDimensionLeadingZero ( bool  dimensionLeadingZero)

Sets the dimension leading zero display property
Created in NX5.0.0.



License requirements : None

Parameters
dimensionLeadingZerodimension leading zero
void NXOpen::Annotations::UnitsFormatPreferences::SetDisplayTrailingZeros ( bool  displayTrailingZeros)

Sets the flag indicating whether to display trailing zeros on dimension values
Created in NX4.0.0.



License requirements : None

Parameters
displayTrailingZerosdisplay trailing zeros
void NXOpen::Annotations::UnitsFormatPreferences::SetDualDimensionCenterDimensionLine ( bool  centerDimensionLine)

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.
Created in NX12.0.0.

License requirements : None

Parameters
centerDimensionLinecenterdimensionline
void NXOpen::Annotations::UnitsFormatPreferences::SetDualDimensionPlacement ( NXOpen::Annotations::DualDimensionPlacement  placement)

Sets the dual dimension placement relative to the primary dimension
Created in NX4.0.0.



License requirements : None

Parameters
placementplacement
void NXOpen::Annotations::UnitsFormatPreferences::SetDualDimensionTextFormat ( NXOpen::Annotations::DimensionTextFormat  textFormat)

Sets the dual dimension text format
Created in NX4.0.0.



License requirements : None

Parameters
textFormattext format
void NXOpen::Annotations::UnitsFormatPreferences::SetDualDimensionUnit ( NXOpen::Annotations::DimensionUnit  unit)

Sets the dual dimension unit
Created in NX4.0.0.



License requirements : None

Parameters
unitunit
void NXOpen::Annotations::UnitsFormatPreferences::SetFractionalDisplay ( bool  fractionalDisplay)

Sets the fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

Parameters
fractionalDisplayfractionaldisplay
void NXOpen::Annotations::UnitsFormatPreferences::SetNumeratorDegrees ( int  numeratorDegrees)

Sets the numerator degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

Parameters
numeratorDegreesnumerator degrees
void NXOpen::Annotations::UnitsFormatPreferences::SetNumeratorFraction ( double  numeratorFraction)

Sets the numerator fractional degrees of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

Parameters
numeratorFractionnumeratorfraction
void NXOpen::Annotations::UnitsFormatPreferences::SetNumeratorMinutes ( int  numeratorMinutes)

Sets the numerator minutes of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

Parameters
numeratorMinutesnumerator minutes
void NXOpen::Annotations::UnitsFormatPreferences::SetNumeratorSeconds ( int  numeratorSeconds)

Sets the numerator seconds of fractional display for angular dimension
Created in NX8.0.0.



License requirements : None

Parameters
numeratorSecondsnumerator seconds
void NXOpen::Annotations::UnitsFormatPreferences::SetPrimaryDimensionTextFormat ( NXOpen::Annotations::DimensionTextFormat  textFormat)

Sets the primary dimension text format
Created in NX4.0.0.



License requirements : None

Parameters
textFormattext format
void NXOpen::Annotations::UnitsFormatPreferences::SetPrimaryDimensionUnit ( NXOpen::Annotations::DimensionUnit  unit)

Sets the primary dimension unit
Created in NX4.0.0.



License requirements : None

Parameters
unitunit
void NXOpen::Annotations::UnitsFormatPreferences::SetSuppressAngularZerosOption ( NXOpen::Annotations::AngularSuppressZeros  option)

Sets the angular dimension suppress zeros option
Created in NX4.0.0.



License requirements : None

Parameters
optionoption
void NXOpen::Annotations::UnitsFormatPreferences::SetToleranceLeadingZero ( bool  toleranceLeadingZero)

Sets the tolerance leading zero display property
Created in NX5.0.0.



License requirements : None

Parameters
toleranceLeadingZerotolerance leading zero
void NXOpen::Annotations::UnitsFormatPreferences::SetTolerancePlacement ( NXOpen::Annotations::TolerancePlacement  placement)

Sets the tolerance text placement relative to the dimension text
Created in NX4.0.0.



License requirements : None

Parameters
placementplacement
NXOpen::Annotations::AngularSuppressZeros NXOpen::Annotations::UnitsFormatPreferences::SuppressAngularZerosOption ( )

Returns the angular dimension suppress zeros option
Created in NX4.0.0.



License requirements : None

bool NXOpen::Annotations::UnitsFormatPreferences::ToleranceLeadingZero ( )

Returns the tolerance leading zero display property
Created in NX5.0.0.



License requirements : None

NXOpen::Annotations::TolerancePlacement NXOpen::Annotations::UnitsFormatPreferences::TolerancePlacement ( )

Returns the tolerance text placement relative to the dimension text
Created in NX4.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.