NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::TextWithSymbolsBuilder Class Reference

Represents a Annotations::TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object. More...

Inheritance diagram for NXOpen::Annotations::TextWithSymbolsBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  SymbolPreferencesType { SymbolPreferencesTypeUseCurrent, SymbolPreferencesTypeUseDefinition }
 Enum for the symbol preferences. More...
enum  SymbolSizingMethod { SymbolSizingMethodScaleAndAspectRatio, SymbolSizingMethodLengthAndHeight }
 sizing method for embedded user-defined symbols More...

Public Member Functions

void AddAttributeReference (NXOpen::NXObject *ownerTag, const NXString &title, bool displayTokens, int lineNo, int cursorPos)
 Adds an attribute reference
Created in NX8.0.0.
void AddExpressionReference (const NXString &expName, const NXString &format, int lineNo, int cursorPos)
 Adds an expression reference
Created in NX8.0.0.
void AddSymbol (NXOpen::NXObject *newObject, const NXString &name, int lineNo, int cursorPos)
 Adds a symbol
Created in NX7.0.0.
double CustomSymbolScale ()
 Returns the scale of the custom symbols
Created in NX7.5.0.
std::vector< NXStringGetText ()
 Returns the text of the annotation.
void RemoveSymbol (const NXString &path)
 Removes specified symbol
Created in NX7.0.0.
void SetCustomSymbolScale (double customSymbolScale)
 Sets the scale of the custom symbols
Created in NX7.5.0.
void SetSymbolAspectRatio (double symbolAspectRatio)
 Sets the aspect ratio of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.
void SetSymbolHeight (double symbolHeight)
 Sets the height of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.
void SetSymbolLength (double symbolLength)
 Sets the length of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.
void SetSymbolPreferences (NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType symbolPreferences)
 Sets the symbol preferences
Created in NX8.0.0.
void SetSymbolScale (double symbolScale)
 Sets the scale of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.
void SetSymbolSizeMethod (NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod symbolSizeMethod)
 Sets the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.
void SetText (const std::vector< NXString > &text)
 Sets the text of the annotation
Created in NX6.0.0.
double SymbolAspectRatio ()
 Returns the aspect ratio of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.
double SymbolHeight ()
 Returns the height of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.
double SymbolLength ()
 Returns the length of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.
NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType SymbolPreferences ()
 Returns the symbol preferences
Created in NX8.0.0.
double SymbolScale ()
 Returns the scale of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.
NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod SymbolSizeMethod ()
 Returns the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a Annotations::TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object.


This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0.


Member Enumeration Documentation

Enum for the symbol preferences.

Enumerator:
SymbolPreferencesTypeUseCurrent 

Use Current.

SymbolPreferencesTypeUseDefinition 

Use Definition.

sizing method for embedded user-defined symbols

Enumerator:
SymbolSizingMethodScaleAndAspectRatio 

Size using scale and aspect ratio.

SymbolSizingMethodLengthAndHeight 

Size using length and height.


Member Function Documentation

void NXOpen::Annotations::TextWithSymbolsBuilder::AddAttributeReference ( NXOpen::NXObject ownerTag,
const NXString title,
bool  displayTokens,
int  lineNo,
int  cursorPos 
)

Adds an attribute reference
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
ownerTagobject that owns the attribute. If we are trying to reference a part attribute then this should be the part object
titletitle of attribute
displayTokensTrue to display using TC tokens. False to display as plain text.
lineNoline number to insert token with index from 1
cursorPoscursor position in the line with index from 1
void NXOpen::Annotations::TextWithSymbolsBuilder::AddExpressionReference ( const NXString expName,
const NXString format,
int  lineNo,
int  cursorPos 
)

Adds an expression reference
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
expNameexpression name
formatformat to use for displaying an expression. 'A' for displaying the expression formula, or 'm.n' where 'm' is the minimum number of characters displayed and 'n' is the number of decimal places to display
lineNoline number to insert token with index from 1
cursorPoscursor position in the line with index from 1
void NXOpen::Annotations::TextWithSymbolsBuilder::AddSymbol ( NXOpen::NXObject newObject,
const NXString name,
int  lineNo,
int  cursorPos 
)

Adds a symbol
Created in NX7.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
newObjectsymbol instance object
namesymbol name
lineNoline number to insert token with index from 1
cursorPoscursor position in the line with index from 1

Returns the scale of the custom symbols
Created in NX7.5.0.



License requirements : None

Returns the text of the annotation.

Returns:

Created in NX6.0.0.

License requirements : None

Removes specified symbol
Created in NX7.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
pathSymbol name

Sets the scale of the custom symbols
Created in NX7.5.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
customSymbolScalecustomsymbolscale

Sets the aspect ratio of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
symbolAspectRatiosymbolaspectratio

Sets the height of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
symbolHeightsymbolheight

Sets the length of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
symbolLengthsymbollength

Sets the symbol preferences
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
symbolPreferencessymbolpreferences

Sets the scale of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
symbolScalesymbolscale

Sets the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
symbolSizeMethodsymbolsizemethod
void NXOpen::Annotations::TextWithSymbolsBuilder::SetText ( const std::vector< NXString > &  text)

Sets the text of the annotation
Created in NX6.0.0.



License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters:
texttext

Returns the aspect ratio of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.



License requirements : None

Returns the height of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.



License requirements : None

Returns the length of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.



License requirements : None

Returns the symbol preferences
Created in NX8.0.0.



License requirements : None

Returns the scale of the embedded user-defined symbols if the symbol size method is Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.



License requirements : None

Returns the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.



License requirements : None

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.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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