NXOpen::Annotations::TextComponent Class Reference

Represents a single text in an annotation and can be queried for information about that text. More...

Inheritance diagram for NXOpen::Annotations::TextComponent:

Public Types
enum	TextType {   TextTypeText, TextTypeDualDimension, TextTypeTolerance, TextTypeDualTolerance,   TextTypeDiameterRadius, TextTypeAppendedAbove, TextTypeAppendedBelow, TextTypeAppendedBefore,   TextTypeAppendedAfter, TextTypeChamferBefore, TextTypeChamferAfter, TextTypeChamferSize,   TextTypeChamferXSymbol, TextTypeChamferAngle }
	the text type. More...

Public Member Functions
NXOpen::Point3d	AdjustedOrigin ()
	Returns the adjusted text origin in absolute coordinates. More...
double	GetAngle ()
	The text angle. More...
double	GetDistanceToTop ()
	The distance from the origin to the top of text. More...
int	GetIntegerizedLength (int nth)
	The text integerized length. More...
std::vector< NXString >	GetText ()
	Gets all of the text for the text component. More...
double	Height ()
	Returns the text height. More...
double	Length ()
	Returns the text length. More...
int	NumberLines ()
	Returns the number of lines of text. More...
NXOpen::Point3d	Origin ()
	Returns the text origin in absolute coordinates. More...
NXOpen::Annotations::TextComponent::TextType	Type ()
	Returns the text type. More...
virtual	~TextComponent ()
	Free resources associated with the text component. More...
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents a single text in an annotation and can be queried for information about that text.

This information includes the type of text, the number of lines of text, the lines of text, and the origin in absolute coordinates.
Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::TextComponent::TextType

the text type.

Enumerator
TextTypeText	primary dimension text or main text for draft aids
TextTypeDualDimension	dual dimension text
TextTypeTolerance	tolerance text
TextTypeDualTolerance	dual tolerance text
TextTypeDiameterRadius	diameter or radius or arc length symbol text
TextTypeAppendedAbove	appended text above
TextTypeAppendedBelow	appended text below
TextTypeAppendedBefore	appended text before
TextTypeAppendedAfter	appended text after
TextTypeChamferBefore	chamfer text before
TextTypeChamferAfter	chamfer text after
TextTypeChamferSize	chamfer size text
TextTypeChamferXSymbol	chamfer x symbol text
TextTypeChamferAngle	chamfer angle symbol text

Constructor & Destructor Documentation

virtual NXOpen::Annotations::TextComponent::~TextComponent ( )

virtual

Free resources associated with the text component.

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 NX6.0.0.

License requirements : None

Member Function Documentation

NXOpen::Point3d NXOpen::Annotations::TextComponent::AdjustedOrigin

(

)

Returns the adjusted text origin in absolute coordinates.

If the annotation is on a drawing, origin is returned in drawing space. If the annotation is on the model, origin is returned in model space. Text origin and adjusted text origin should be equivalent except for underline notes The adjusted origin is used for display
Created in NX11.0.2.

License requirements : None

double NXOpen::Annotations::TextComponent::GetAngle

(

)

The text angle.

Returns

the text angle
Created in NX12.0.0.

License requirements : None

double NXOpen::Annotations::TextComponent::GetDistanceToTop

(

)

The distance from the origin to the top of text.

Returns

the distance from the origin to the top of text
Created in NX6.0.0.

License requirements : None

int NXOpen::Annotations::TextComponent::GetIntegerizedLength

(

int

nth

)

The text integerized length.

Returns

the text integerized length
Created in NX6.0.0.

License requirements : None

Parameters

nth	the nth text. nth starts with 0.

std::vector<NXString> NXOpen::Annotations::TextComponent::GetText

(

)

Gets all of the text for the text component.

Returns

the lines of text
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::TextComponent::Height

(

)

Returns the text height.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::TextComponent::Length

(

)

Returns the text length.

Created in NX6.0.0.

License requirements : None

int NXOpen::Annotations::TextComponent::NumberLines

(

)

Returns the number of lines of text.

Created in NX6.0.0.

License requirements : None

NXOpen::Point3d NXOpen::Annotations::TextComponent::Origin

(

)

Returns the text origin in absolute coordinates.

If the annotation is on a drawing, origin is returned in drawing space. If the annotation is on the model, origin is returned in model space.
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::TextComponent::TextType NXOpen::Annotations::TextComponent::Type

(

)

Returns the text type.

Created in NX6.0.0.

License requirements : None

---

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

• Annotations_TextComponent.hxx