Associative text class creates text associated to object and part attributes as well as object properties such as a drawing sheet name. More...

Inheritance diagram for NXOpen::Annotations::AssociativeText:

Public Types
enum	PropertyType { PropertyTypeDrawingNumberOfSheets, PropertyTypeDrawingNumberOfPrimarySheets, PropertyTypeDrawingSheetName, PropertyTypeDrawingSheetNumber, PropertyTypeDrawingSheetRevision, PropertyTypeDrawingSheetScaleNumerator, PropertyTypeDrawingSheetScaleDenominator, PropertyTypeDrawingSheetSize, PropertyTypeDrawingSheetUnits, PropertyTypeDrawingSheetZone, PropertyTypeDrawingSheetProjectionAngle, PropertyTypeDrawingMasterPartName, PropertyTypeDrawingPartName, PropertyTypeDrawingViewPrefix, PropertyTypeDrawingViewRotationAngle }
	the associative text property type to be used with the object More...

Public Member Functions
NXString	GetEvaluatedText (NXOpen::Annotations::Annotation *ann, const NXString &text)
	Evaluate the associative text specified.

NXString	GetEvaluatedText (NXOpen::Annotations::Annotation ann, const char text)
	Evaluate the associative text specified.

NXString	GetObjectAttributeText (NXOpen::NXObject *object, const NXString &attributeTitle)
	Returns the associative text for the input object and attribute title.

NXString	GetObjectAttributeText (NXOpen::NXObject object, const char attributeTitle)
	Returns the associative text for the input object and attribute title.

NXString	GetObjectPropertyText (NXOpen::NXObject *object, NXOpen::Annotations::AssociativeText::PropertyType type)
	Returns the associative text for the input object and its property.

NXString	GetPartAttributeText (const NXString &attributeTitle)
	Returns the associative text for the part attribute title.

NXString	GetPartAttributeText (const char *attributeTitle)
	Returns the associative text for the part attribute title.

virtual	~AssociativeText ()
	Frees the object from memory.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

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.

Member Enumeration Documentation

enum NXOpen::Annotations::AssociativeText::PropertyType

the associative text property type to be used with the object

Enumerator:

PropertyTypeDrawingNumberOfSheets	Drawing sheet number of sheets.
PropertyTypeDrawingNumberOfPrimarySheets	Drawing sheet number of primary sheets.
PropertyTypeDrawingSheetName	Drawing sheet name.
PropertyTypeDrawingSheetNumber	Drawing sheet number.
PropertyTypeDrawingSheetRevision	Drawing sheet revision.
PropertyTypeDrawingSheetScaleNumerator	Drawing sheet scale numerator.
PropertyTypeDrawingSheetScaleDenominator	Drawing sheet scale denominator.
PropertyTypeDrawingSheetSize	Drawing sheet size.
PropertyTypeDrawingSheetUnits	Drawing sheet units.
PropertyTypeDrawingSheetZone	Drawing sheet zone.
PropertyTypeDrawingSheetProjectionAngle	Drawing sheet projection angle.
PropertyTypeDrawingMasterPartName	Drawing master part name.
PropertyTypeDrawingPartName	Drawing part name.
PropertyTypeDrawingViewPrefix	Drawing view prefix.
PropertyTypeDrawingViewRotationAngle	View rotation angle.

Constructor & Destructor Documentation

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

Member Function Documentation

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"

Returns: the text with the evaluated associative text
Created in NX8.0.0.

License requirements : None

Parameters

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::GetEvaluatedText	(	NXOpen::Annotations::Annotation *	ann,
		const char *	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"

Returns: the text with the evaluated associative text
Created in NX8.0.0.

License requirements : None

Parameters

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.

Returns: the associative text
Created in NX8.0.0.

License requirements : None

Parameters

object	the object
attributeTitle	the object attribute title

NXString NXOpen::Annotations::AssociativeText::GetObjectAttributeText	(	NXOpen::NXObject *	object,
		const char *	attributeTitle
	)

Returns the associative text for the input object and attribute title.

Returns: the associative text
Created in NX8.0.0.

License requirements : None

Parameters

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.

    <br>   
   For example, drawing sheet name, where the object is the drawing sheet and its name is the property. <br> 
    @return  the associative text

Created in NX8.0.0.

License requirements : None

Parameters

object	the object
type	the object property

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeText ( const NXString & attributeTitle )

Returns the associative text for the part attribute title.

Returns: the associative text
Created in NX8.0.0.

License requirements : None

Parameters

attributeTitle the part attribute title

NXString NXOpen::Annotations::AssociativeText::GetPartAttributeText ( const char * attributeTitle )

Returns the associative text for the part attribute title.

Returns: the associative text
Created in NX8.0.0.

License requirements : None

Parameters

attributeTitle the part attribute title

The documentation for this class was generated from the following file:

Annotations_AssociativeText.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation