NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Annotations.LeaderBundle Class Reference

Represents the data for all the leaders of an annotation More...

Inheritance diagram for NXOpen.Annotations.LeaderBundle:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe void SetLeaderData (int n, NXOpen.Annotations.LeaderAttachment attachmentType, NXOpen.NXObject attachmentObject, NXOpen.View attachmentView, NXOpen.Point3d endPoint, double angle, NXOpen.Point3d[] intermediatePoints)
 Sets the leader data for the nth leader 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...
 

Properties

unsafe
NXOpen.Annotations.LeaderAlignment 
LeaderAlignment [get, set]
 Returns or sets the leader alignment More...
 
unsafe
NXOpen.Annotations.LeaderSide 
LeaderSide [get, set]
 Returns or sets the leader side More...
 
unsafe
NXOpen.Annotations.LeaderType 
LeaderType [get, set]
 Returns or sets the leader type More...
 
unsafe int NumberOfLeaders [get, set]
 Returns or sets the number of leaders. 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 the data for all the leaders of an annotation

Created in NX3.0.0

Member Function Documentation

override void NXOpen.Annotations.LeaderBundle.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 NX3.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.Annotations.LeaderBundle.SetLeaderData ( int  n,
NXOpen.Annotations.LeaderAttachment  attachmentType,
NXOpen.NXObject  attachmentObject,
NXOpen.View  attachmentView,
NXOpen.Point3d  endPoint,
double  angle,
NXOpen.Point3d[]  intermediatePoints 
)
inline

Sets the leader data for the nth leader

Created in NX3.0.0

License requirements: None.

Parameters
nThe leader to set the data for
attachmentType
attachmentObjectAttachment object. Should be a null reference (Nothing in Visual Basic) if the attachment type is Screen. Must not be a null reference (Nothing in Visual Basic) if the attachment type is OnObject.
attachmentViewThe view that the leader will be associated with. Must not be a null reference (Nothing in Visual Basic)
endPointThe coordinates of the leader's end point. If the attachment type is Screen, the coordinates will be view coordinates. If the attachment type is OnObject, the coordinates will be in the absolute coordinate system of the model that owns the attachment object
angle
intermediatePointsIntermediate points for the leader. The number of points must not exceed NXOpen.Annotations.Constants.MaxLeaderIntermediatePoints . The points are in the view coordinate system. The only leader types that permit intermediate points are the following: Plain, Around, PlainAligned, AroundAligned, DatumArrow, and GbDatumArrow.

Property Documentation

unsafe NXOpen.Annotations.LeaderAlignment NXOpen.Annotations.LeaderBundle.LeaderAlignment
getset

Returns or sets the leader alignment

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.LeaderSide NXOpen.Annotations.LeaderBundle.LeaderSide
getset

Returns or sets the leader side

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Annotations.LeaderType NXOpen.Annotations.LeaderBundle.LeaderType
getset

Returns or sets the leader type

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Annotations.LeaderBundle.NumberOfLeaders
getset

Returns or sets the number of leaders.

Must not exceed NXOpen.Annotations.Constants.MaxLeaders . The only leader types that permit more than one leader are the following: Plain, Around, PlainAligned, and AroundAligned. PlainAligned and AroundAligned require at least one leader.

Created in NX3.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.