NX Open C++ Reference Guide
|
Associative text class creates text associated to object and part attributes as well as object properties such as a drawing sheet name. More...
Associative text class creates text associated to object and part attributes as well as object properties such as a drawing sheet name.
The associative text is constructed using special NX text control sequences.
The text created using this class can be added to a table cell, note text, dimension appended text etc...
Created in NX8.0.0.
the associative text property type to be used with the object
virtual NXOpen::Annotations::AssociativeText::~AssociativeText | ( | ) | [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 NX8.0.0.
License requirements : None
NXString NXOpen::Annotations::AssociativeText::GetEvaluatedText | ( | NXOpen::Annotations::Annotation * | ann, |
const NXString & | text | ||
) |
Evaluate the associative text specified.
Convert associative text to the string that it represents. The following associative text control sequences will be evaluated: part attribute references, object attribute references, expression references, and object property references. Example: The value of part attribute "ATT1" is "Value1". The text that represents the reference to part attribute "ATT1" is "\<W@ATT1\>" The value of expression "p1" is "3.00". The text that represents the reference to expression "p1" is "\<X0.2@p1\>". The value of object property "\<WRef1*0@$SH_SHEET_NAME\>" is "Sheet 1". Given the input text "\<WRef1*0@$SH_SHEET_NAME\> \<X0.2@p1\> \<W@ATT1\>" the evaluated text returned will be "Sheet 1 3.00 Value1"
ann | Annotation used to determine the object property value when the object is not specified. For example, given annotation 123 and 456 where 123 resides in "Sheet 1" and 456 resides in "Sheet 2" then the evaluated text returned for the input text "\<W@$SH_SHEET_NAME\>" for annotation 123 is "Sheet 1" and for annotation 456 is "Sheet 2" |
text | the text containing assiative text to evaluate |
NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeText | ( | NXOpen::NXObject * | object, |
const NXString & | attributeTitle | ||
) |
Returns the associative text for the input object and attribute title.
object | the object |
attributeTitle | the object attribute title |
NXString NXOpen::Annotations::AssociativeText::GetObjectPropertyText | ( | NXOpen::NXObject * | object, |
NXOpen::Annotations::AssociativeText::PropertyType | type | ||
) |
Returns the associative text for the input object and its property.
For example, drawing sheet name, where the object is the drawing sheet and its name is the property.
object | the object |
type | the object property |
NXString NXOpen::Annotations::AssociativeText::GetPartAttributeText | ( | const NXString & | attributeTitle | ) |
Returns the associative text for the part attribute title.
attributeTitle | the part attribute title |