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

Represents a NXOpen.Annotations.LeaderData . More...

Inheritance diagram for NXOpen.Annotations.LeaderData:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ArrowheadType {
  ClosedArrow, ClosedSolidArrow, OpenArrow, FilledArrow,
  ClosedDoubleArrow, ClosedDoubleSolidArrow, OpenDoubleArrow, FilledDoubleArrow,
  None, Origin, Cross, Integral,
  Dot, FilledDot, Square, FilledSquare,
  Datum, FilledDatum, TopOpenArrow, BottomOpenArrow,
  TopFilledArrow, BottomFilledArrow
}
 the set of arrowhead types used to define a leader arrowhead More...
 
enum  LeaderType {
  Plain, AllAround, PlainWithoutStub, Flag,
  Datum, DotTerminated, Extension, AllOver
}
 the set of datatypes used to define the types of leaders that can be applied to an annotation More...
 

Public Member Functions

unsafe NXOpen.Point3d GetStubEndPoint ()
 Returns the end point of the leader. More...
 
unsafe NXOpen.Point3d GetStubStartPoint ()
 Returns the start point of the leader. More...
 
unsafe bool HasStub ()
 Returns the stub status of the defined leader. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override 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...
 

Properties

unsafe
NXOpen.Annotations.LeaderData.ArrowheadType 
Arrowhead [get, set]
 Returns or sets the arrowhead More...
 
unsafe
NXOpen.Annotations.LeaderData.ArrowheadType 
DatumOnDotTerminatedArrowhead [get, set]
 Returns or sets the datum arrowhead type for the datum portion of a datum on dot terminated leader More...
 
unsafe NXOpen.Point3d DatumOnDotTerminatedEndPoint [get, set]
 Returns or sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet More...
 
unsafe NXOpen.Point3d DatumOnDotTerminatedStartPoint [get, set]
 Returns or sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader More...
 
unsafe
NXOpen.SelectDisplayableObjectList 
Jogs [get]
 Returns the jogs More...
 
unsafe
NXOpen.SelectDisplayableObject 
Leader [get]
 Returns the leader More...
 
unsafe bool LeaderPerpendicular [get, set]
 Returns or sets the perpendicular relationship between the first segment and attachement object More...
 
unsafe bool Perpendicular [get, set]
 Returns or sets the perpendicular relationship between the first segment and stub More...
 
unsafe
NXOpen.Annotations.LeaderSide 
StubSide [get, set]
 Returns or sets the stub side More...
 
unsafe double StubSize [get, set]
 Returns or sets the stub size More...
 
unsafe
NXOpen.Annotations.LeaderData.LeaderType 
TerminatorType [get, set]
 Returns or sets the terminator type More...
 
unsafe
NXOpen.Annotations.LeaderVerticalAttachment 
VerticalAttachment [get, set]
 Returns or sets the vertical attachment More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Annotations.LeaderData .

This class is used to construct the definition for a single leader object.

To create a new instance of this class, use NXOpen.Annotations.AnnotationManager.CreateLeaderData

Created in NX6.0.0

Member Enumeration Documentation

the set of arrowhead types used to define a leader arrowhead

Enumerator
ClosedArrow 

Closed arrowhead type

ClosedSolidArrow 

Closed solid arrowhead type

OpenArrow 

Open arrowhead type

FilledArrow 

Filled arrowhead type

ClosedDoubleArrow 

Closed double arrowhead type

ClosedDoubleSolidArrow 

Closed double solid arrowhead type

OpenDoubleArrow 

Open double arrowhead type

FilledDoubleArrow 

Filled double arrowhead type

None 

No terminating symbol

Origin 

Origin symbol

Cross 

Cross symbol

Integral 

Integral symbol

Dot 

Dot symbol

FilledDot 

Filled dot symbol

Square 

Square symbol

FilledSquare 

Filled square symbol

Datum 

Datum symbol

FilledDatum 

Filled datum symbol

TopOpenArrow 

Top open arrowhead

BottomOpenArrow 

bottom open arrowhead

TopFilledArrow 

top filled arrowhead

BottomFilledArrow 

bottom filled arrowhead

the set of datatypes used to define the types of leaders that can be applied to an annotation

Enumerator
Plain 

Plain leader style

AllAround 

Plain leader style with all around symbol

PlainWithoutStub 

Plain leader style with no stub

Flag 

Flag style

Datum 

Datum feature symbol style

DotTerminated 

Datum feature on stub of dot terminated style

Extension 

Id symbol extension style leader

AllOver 

Member Function Documentation

unsafe NXOpen.Point3d NXOpen.Annotations.LeaderData.GetStubEndPoint ( )
inline

Returns the end point of the leader.

Created in NX11.0.0

License requirements: None.

Returns
unsafe NXOpen.Point3d NXOpen.Annotations.LeaderData.GetStubStartPoint ( )
inline

Returns the start point of the leader.

Created in NX11.0.0

License requirements: None.

Returns
unsafe bool NXOpen.Annotations.LeaderData.HasStub ( )
inline

Returns the stub status of the defined leader.

Created in NX11.0.0

License requirements: None.

Returns
unsafe bool NXOpen.Annotations.LeaderData.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Annotations.LeaderData.ArrowheadType NXOpen.Annotations.LeaderData.Arrowhead
getset

Returns or sets the arrowhead

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Annotations.LeaderData.ArrowheadType NXOpen.Annotations.LeaderData.DatumOnDotTerminatedArrowhead
getset

Returns or sets the datum arrowhead type for the datum portion of a datum on dot terminated leader

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Point3d NXOpen.Annotations.LeaderData.DatumOnDotTerminatedEndPoint
getset

Returns or sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Point3d NXOpen.Annotations.LeaderData.DatumOnDotTerminatedStartPoint
getset

Returns or sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.SelectDisplayableObjectList NXOpen.Annotations.LeaderData.Jogs
get

Returns the jogs

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.SelectDisplayableObject NXOpen.Annotations.LeaderData.Leader
get

Returns the leader

Created in NX6.0.0

License requirements: None.

unsafe bool NXOpen.Annotations.LeaderData.LeaderPerpendicular
getset

Returns or sets the perpendicular relationship between the first segment and attachement object

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe bool NXOpen.Annotations.LeaderData.Perpendicular
getset

Returns or sets the perpendicular relationship between the first segment and stub

Created in NX7.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Annotations.LeaderSide NXOpen.Annotations.LeaderData.StubSide
getset

Returns or sets the stub side

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe double NXOpen.Annotations.LeaderData.StubSize
getset

Returns or sets the stub size

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Annotations.LeaderData.LeaderType NXOpen.Annotations.LeaderData.TerminatorType
getset

Returns or sets the terminator type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe NXOpen.Annotations.LeaderVerticalAttachment NXOpen.Annotations.LeaderData.VerticalAttachment
getset

Returns or sets the vertical attachment

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING")


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