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 {   Text, DualDimension, Tolerance, DualTolerance,   DiameterRadius, AppendedAbove, AppendedBelow, AppendedBefore,   AppendedAfter, ChamferBefore, ChamferAfter, ChamferSize,   ChamferXSymbol, ChamferAngle }
	the text type. More...

Public Member Functions
unsafe double	GetAngle ()
	The text angle. More...
unsafe double	GetDistanceToTop ()
	The distance from the origin to the top of text. More...
unsafe int	GetIntegerizedLength (int nth)
	The text integerized length. More...
unsafe string[]	GetText ()
	Gets all of the text for the text component. More...
Public Member Functions inherited from NXOpen.TransientObject
void	Dispose ()
	Frees the object from memory. More...
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
new string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Protected Member Functions
override void	FreeResource ()
	Free resources associated with the text component. More...

Properties
unsafe NXOpen.Point3d	AdjustedOrigin [get]
	Returns the adjusted text origin in absolute coordinates. More...
unsafe double	Height [get]
	Returns the text height. More...
unsafe double	Length [get]
	Returns the text length. More...
unsafe int	NumberLines [get]
	Returns the number of lines of text. More...
unsafe NXOpen.Point3d	Origin [get]
	Returns the text origin in absolute coordinates. More...
unsafe NXOpen.Annotations.TextComponent.TextType	Type [get]
	Returns the text type. More...
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. 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
Text	primary dimension text or main text for draft aids
DualDimension	dual dimension text
Tolerance	tolerance text
DualTolerance	dual tolerance text
DiameterRadius	diameter or radius or arc length symbol text
AppendedAbove	appended text above
AppendedBelow	appended text below
AppendedBefore	appended text before
AppendedAfter	appended text after
ChamferBefore	chamfer text before
ChamferAfter	chamfer text after
ChamferSize	chamfer size text
ChamferXSymbol	chamfer x symbol text
ChamferAngle	chamfer angle symbol text

Member Function Documentation

override void NXOpen.Annotations.TextComponent.FreeResource ( )

inlineprotectedvirtual

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.

Implements NXOpen.TransientObject.

unsafe double NXOpen.Annotations.TextComponent.GetAngle ( )

inline

The text angle.

Created in NX12.0.0

License requirements: None.

Returns

the text angle

unsafe double NXOpen.Annotations.TextComponent.GetDistanceToTop ( )

inline

The distance from the origin to the top of text.

Created in NX6.0.0

License requirements: None.

Returns

the distance from the origin to the top of text

unsafe int NXOpen.Annotations.TextComponent.GetIntegerizedLength ( int  nth )

inline

The text integerized length.

Created in NX6.0.0

License requirements: None.

Parameters

nth	the nth text. nth starts with 0.

Returns

the text integerized length

unsafe string [] NXOpen.Annotations.TextComponent.GetText ( )

inline

Gets all of the text for the text component.

Created in NX6.0.0

License requirements: None.

Returns

the lines of text

Property Documentation

unsafe NXOpen.Point3d NXOpen.Annotations.TextComponent.AdjustedOrigin

get

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.

unsafe double NXOpen.Annotations.TextComponent.Height

get

Returns the text height.

Created in NX6.0.0

License requirements: None.

unsafe double NXOpen.Annotations.TextComponent.Length

get

Returns the text length.

Created in NX6.0.0

License requirements: None.

unsafe int NXOpen.Annotations.TextComponent.NumberLines

get

Returns the number of lines of text.

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Point3d NXOpen.Annotations.TextComponent.Origin

get

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.

unsafe NXOpen.Annotations.TextComponent.TextType NXOpen.Annotations.TextComponent.Type

get

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.cs