NXOpen.Annotations.ComponentData Class Reference

A ComponentData object can be used to query the components of an annotation. More...

Inheritance diagram for NXOpen.Annotations.ComponentData:

Public Member Functions
unsafe NXOpen.Annotations.ArcComponent[]	GetArcComponents ()
	Queries the arc components, (NXOpen.Annotations.ArcComponent ), in an annotation. More...
unsafe NXOpen.Annotations.ArrowComponent[]	GetArrowComponents ()
	Queries the arrow components, (NXOpen.Annotations.ArrowComponent ), in an annotation. More...
unsafe NXOpen.DisplayableObject[]	GetEntities ()
	Returns the entities that an annotation contains. More...
unsafe NXOpen.DisplayableObject[]	GetEntitiesAutodelete ()
	Returns the entities that an annotation contains. More...
unsafe NXOpen.Annotations.LineComponent[]	GetLineComponents ()
	Queries the line components, (NXOpen.Annotations.LineComponent ), in an annotation. More...
unsafe NXOpen.Annotations.TextComponent[]	GetTextComponents ()
	Queries the text components, (NXOpen.Annotations.TextComponent ), in an annotation. 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 ()
	Frees the object from memory. More...

Additional Inherited Members
Properties inherited from NXOpen.TransientObject
IntPtr	Handle [get]
	Handle of the internal object represented by this object. More...

Detailed Description

A ComponentData object can be used to query the components of an annotation.

These components include line components, arrow components, arc components, and text components. These components can then be queried for type specific information about the object.

Created in NX6.0.2

Member Function Documentation

override void NXOpen.Annotations.ComponentData.FreeResource ( )

inlineprotectedvirtual

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

License requirements: None.

Implements NXOpen.TransientObject.

unsafe NXOpen.Annotations.ArcComponent [] NXOpen.Annotations.ComponentData.GetArcComponents ( )

inline

Queries the arc components, (NXOpen.Annotations.ArcComponent ), in an annotation.

Each arc component can be queried for arc specific information.

Created in NX6.0.2

License requirements: None.

Returns

All of the arc components that exist in the annotation

unsafe NXOpen.Annotations.ArrowComponent [] NXOpen.Annotations.ComponentData.GetArrowComponents ( )

inline

Queries the arrow components, (NXOpen.Annotations.ArrowComponent ), in an annotation.

Each arrow component can be queried for arrow specific information.

Created in NX6.0.2

License requirements: None.

Returns

All of the arrow components that exist in the annotation

unsafe NXOpen.DisplayableObject [] NXOpen.Annotations.ComponentData.GetEntities ( )

inline

Returns the entities that an annotation contains.

These entities are NX objects such as NXOpen.Line and NXOpen.Annotations.Annotation . Appropriate query APIs can be used for these entities to get details such as geometric data.

This method can be used for container objects such as Custom Symbol NXOpen.Annotations.CustomSymbol to get entities that the custom sybmols is made of.

Note that this method will not return components of an annotation such as arrow or crosshatch lines. To query component information, you can use component classes such as NXOpen.Annotations.ArrowComponent and NXOpen.Annotations.LineComponent .

Created in NX6.0.2

License requirements: None.

Returns

List of entities that display the annotation. It is the caller's responsibility to delete these objects.

unsafe NXOpen.DisplayableObject [] NXOpen.Annotations.ComponentData.GetEntitiesAutodelete ( )

inline

Returns the entities that an annotation contains.

These entities are NX objects such as NXOpen.Line and NXOpen.Annotations.Annotation . Appropriate query APIs can be used for these entities to get details such as geometric data.

This method can be used for container objects such as Custom Symbol NXOpen.Annotations.CustomSymbol to get entities that the custom sybmols is made of.

Note that to query components of an annotation such as arrow or crosshatch lines, you can use component classes such as NXOpen.Annotations.ArrowComponent and NXOpen.Annotations.LineComponent .

These entites will be deleted when this object is deleted.

Created in NX11.0.0

License requirements: None.

Returns

List of entities that display the annotation. These entities will be deleted when the ComponentData object is deleted.

unsafe NXOpen.Annotations.LineComponent [] NXOpen.Annotations.ComponentData.GetLineComponents ( )

inline

Queries the line components, (NXOpen.Annotations.LineComponent ), in an annotation.

Each line component can be queried for line specific information.

Created in NX6.0.2

License requirements: None.

Returns

All of the lines components that exist in the annotation

unsafe NXOpen.Annotations.TextComponent [] NXOpen.Annotations.ComponentData.GetTextComponents ( )

inline

Queries the text components, (NXOpen.Annotations.TextComponent ), in an annotation.

Each text component can be queried for text specific information.

Created in NX6.0.2

License requirements: None.

Returns

All of the text components that exist in the annotation

---

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

• Annotations_ComponentData.cs