NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::OrdinateDimensionPreferences Class Reference

Represents ordinate dimension preferences
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::OrdinateDimensionPreferences:
NXOpen::TransientObject

List of all members.

Public Member Functions

bool AlignSymbolWithBaseline ()
 Returns the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.
double DoglegAngle ()
 Returns the dogleg angle
Created in NX4.0.0.
NXOpen::Annotations::OrdinateDoglegCreationOption DoglegCreationOption ()
 Returns the dogleg creation option
Created in NX4.0.0.
NXOpen::Annotations::OrdinateDoglegDefinition DoglegDefinition ()
 Returns the dogleg definition
Created in NX4.0.0.
double DoglegEndOffset ()
 Returns the dogleg end offset
Created in NX4.0.0.
double DoglegStartOffset ()
 Returns the dogleg start offset
Created in NX4.0.0.
double FirstMarginOffset ()
 Returns the first margin offset
Created in NX4.0.0.
NXOpen::Annotations::OrdinateLineArrowDisplayOption LineArrowDisplayOption ()
 Returns the dimension line and arrow display option
Created in NX4.0.0.
double MarginSpacing ()
 Returns the spacing, the distance between margins
Created in NX4.0.0.
double NumberOfMargins ()
 Returns the number of margins
Created in NX4.0.0.
NXOpen::Annotations::OrdinateOriginDisplayOption OriginDisplay ()
 Returns the origin display option
Created in NX4.0.0.
NXOpen::Annotations::OrdinatePositiveDirection PositiveDirection ()
 Returns the positive direction
Created in NX4.0.0.
void SetAlignSymbolWithBaseline (bool alignSymbolWithBaseline)
 Sets the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.
void SetDoglegAngle (double doglegAngle)
 Sets the dogleg angle
Created in NX4.0.0.
void SetDoglegCreationOption (NXOpen::Annotations::OrdinateDoglegCreationOption option)
 Sets the dogleg creation option
Created in NX4.0.0.
void SetDoglegDefinition (NXOpen::Annotations::OrdinateDoglegDefinition definition)
 Sets the dogleg definition
Created in NX4.0.0.
void SetDoglegEndOffset (double doglegEndOffset)
 Sets the dogleg end offset
Created in NX4.0.0.
void SetDoglegStartOffset (double doglegStartOffset)
 Sets the dogleg start offset
Created in NX4.0.0.
void SetFirstMarginOffset (double firstMarginOffset)
 Sets the first margin offset
Created in NX4.0.0.
void SetLineArrowDisplayOption (NXOpen::Annotations::OrdinateLineArrowDisplayOption option)
 Sets the dimension line and arrow display option
Created in NX4.0.0.
void SetMarginSpacing (double marginSpacing)
 Sets the spacing, the distance between margins
Created in NX4.0.0.
void SetNumberOfMargins (double nMargins)
 Sets the number of margins
Created in NX4.0.0.
void SetOriginDisplay (NXOpen::Annotations::OrdinateOriginDisplayOption option)
 Sets the origin display option
Created in NX4.0.0.
void SetPositiveDirection (NXOpen::Annotations::OrdinatePositiveDirection option)
 Sets the positive direction
Created in NX4.0.0.
void SetSymbolAngle (double symbolAngle)
 Sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.
void SetSymbolAspectRatio (double symbolAspectRatio)
 Sets the user defined symbol aspect ratio
Created in NX4.0.0.
void SetSymbolHeight (double symbolHeight)
 Sets the user defined symbol height
Created in NX4.0.0.
void SetSymbolLength (double symbolLength)
 Sets the user defined symbol length
Created in NX4.0.0.
void SetSymbolScale (double symbolScale)
 Sets the user defined symbol scale
Created in NX4.0.0.
void SetTextOrientation (NXOpen::Annotations::TextOrientation orientation)
 Sets the text orientation
Created in NX5.0.0.
void SetTextOrientationAngle (double textOrientationAngle)
 Sets the angle if text orientation is Annotations::TextOrientationByAngle
Created in NX5.0.0.
void SetUserDefinedText (const NXString &userDefinedText)
 Sets the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.
double SymbolAngle ()
 Returns the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.
double SymbolAspectRatio ()
 Returns the user defined symbol aspect ratio
Created in NX4.0.0.
double SymbolHeight ()
 Returns the user defined symbol height
Created in NX4.0.0.
double SymbolLength ()
 Returns the user defined symbol length
Created in NX4.0.0.
double SymbolScale ()
 Returns the user defined symbol scale
Created in NX4.0.0.
NXOpen::Annotations::TextOrientation TextOrientation ()
 Returns the text orientation
Created in NX5.0.0.
double TextOrientationAngle ()
 Returns the angle if text orientation is Annotations::TextOrientationByAngle
Created in NX5.0.0.
NXString UserDefinedText ()
 Returns the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.
virtual ~OrdinateDimensionPreferences ()
 Frees the object from memory.

Detailed Description

Represents ordinate dimension preferences
Created in NX4.0.0.



Constructor & Destructor Documentation

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

Returns the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.



License requirements : None

Returns the dogleg angle
Created in NX4.0.0.



License requirements : None

Returns the dogleg creation option
Created in NX4.0.0.



License requirements : None

Returns the dogleg definition
Created in NX4.0.0.



License requirements : None

Returns the dogleg end offset
Created in NX4.0.0.



License requirements : None

Returns the dogleg start offset
Created in NX4.0.0.



License requirements : None

Returns the first margin offset
Created in NX4.0.0.



License requirements : None

Returns the dimension line and arrow display option
Created in NX4.0.0.



License requirements : None

Returns the spacing, the distance between margins
Created in NX4.0.0.



License requirements : None

Returns the number of margins
Created in NX4.0.0.



License requirements : None

Returns the origin display option
Created in NX4.0.0.



License requirements : None

Returns the positive direction
Created in NX4.0.0.



License requirements : None

Sets the flag indicating whether to align the user defined symbol with the base line
Created in NX4.0.0.



License requirements : None

Parameters:
alignSymbolWithBaselineFlag to align user defined symbol with base line

Sets the dogleg angle
Created in NX4.0.0.



License requirements : None

Parameters:
doglegAngleNew dogleg angle

Sets the dogleg creation option
Created in NX4.0.0.



License requirements : None

Parameters:
optionNew dogleg creation option

Sets the dogleg definition
Created in NX4.0.0.



License requirements : None

Parameters:
definitionNew dogleg definition

Sets the dogleg end offset
Created in NX4.0.0.



License requirements : None

Parameters:
doglegEndOffsetNew dogleg end offset

Sets the dogleg start offset
Created in NX4.0.0.



License requirements : None

Parameters:
doglegStartOffsetNew dogleg start offset

Sets the first margin offset
Created in NX4.0.0.



License requirements : None

Parameters:
firstMarginOffsetNew first margin offeset

Sets the dimension line and arrow display option
Created in NX4.0.0.



License requirements : None

Parameters:
optionNew dimension line and arrow display option

Sets the spacing, the distance between margins
Created in NX4.0.0.



License requirements : None

Parameters:
marginSpacingNew margin spacing

Sets the number of margins
Created in NX4.0.0.



License requirements : None

Parameters:
nMarginsNew number of margins

Sets the origin display option
Created in NX4.0.0.



License requirements : None

Parameters:
optionNew origin display option

Sets the positive direction
Created in NX4.0.0.



License requirements : None

Parameters:
optionNew postive direction

Sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.



License requirements : None

Parameters:
symbolAngleNew user defined symbol angle

Sets the user defined symbol aspect ratio
Created in NX4.0.0.



License requirements : None

Parameters:
symbolAspectRatioNew user defined symbol aspect ratio

Sets the user defined symbol height
Created in NX4.0.0.



License requirements : None

Parameters:
symbolHeightNew user defined symbol height

Sets the user defined symbol length
Created in NX4.0.0.



License requirements : None

Parameters:
symbolLengthNew user defined symbol length

Sets the user defined symbol scale
Created in NX4.0.0.



License requirements : None

Parameters:
symbolScaleNew user defiend symbol scale

Sets the text orientation
Created in NX5.0.0.



License requirements : None

Parameters:
orientationNew dimension text orientation

Sets the angle if text orientation is Annotations::TextOrientationByAngle
Created in NX5.0.0.



License requirements : None

Parameters:
textOrientationAngleNew dimension text orienation angle

Sets the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.



License requirements : None

Parameters:
userDefinedTextNew user defined text

Returns the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
Created in NX4.0.0.



License requirements : None

Returns the user defined symbol aspect ratio
Created in NX4.0.0.



License requirements : None

Returns the user defined symbol height
Created in NX4.0.0.



License requirements : None

Returns the user defined symbol length
Created in NX4.0.0.



License requirements : None

Returns the user defined symbol scale
Created in NX4.0.0.



License requirements : None

Returns the text orientation
Created in NX5.0.0.



License requirements : None

Returns the angle if text orientation is Annotations::TextOrientationByAngle
Created in NX5.0.0.



License requirements : None

Returns the user defined text, if the user defined symbol option is used to display the origin
Created in NX4.0.0.



License requirements : None


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