Represents a simple drafting aid. More...

Inheritance diagram for NXOpen.Annotations.SimpleDraftingAid:

Public Member Functions
unsafe string[]	GetText ()
	Returns the drafting aid's text More...

unsafe NXOpen.Annotations.UserSymbolPreferences	GetUserSymbolPreferences ()
	Returns the user symbol preferences More...

unsafe void	GetUserSymbolSize (out NXOpen.Annotations.UserSymbolPreferences.SizeType sizeType, out double lengthOrScale, out double heightOrAspectRatio)
	Gets the user symbol size More...

unsafe void	SetText (string[] lines)
	Sets the drafting aid's text. More...

unsafe void	SetUserSymbolPreferences (NXOpen.Annotations.UserSymbolPreferences usymPrefs)
	Sets the user symbol preferences. More...

unsafe void	SetUserSymbolSize (NXOpen.Annotations.UserSymbolPreferences.SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
	Sets the user symbol size. More...

Additional Inherited Members
Public Types inherited from NXOpen.DisplayableObject
enum	ObjectFont { Solid = 1, Dashed, Phantom, Centerline, Dotted, LongDashed, DottedDashed, Eight = 11, Nine, Ten, Eleven }
	specifies the object font for objects such as lines More...

enum	ObjectWidth { Normal, Thick, Thin, One = 5, Two, Three, Four, Five, Six, Seven, Eight, Nine }
	specifies object width for objects such as lines and text More...

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

Properties inherited from NXOpen.Annotations.Annotation
unsafe NXOpen.Point3d	AnnotationOrigin `[get, set]`
	Returns or sets the origin (location) of the annotation. More...

unsafe NXOpen.Xform	AnnotationPlane `[get, set]`
	Returns or sets the annotation plane. More...

unsafe bool	HasAssociativeOrigin `[get]`
	Returns a flag indicating whether the origin is associative More...

unsafe bool	IsOutOfDate `[get]`
	Returns the flag indicating whether the annotation is out of date More...

unsafe bool	IsRetained `[get]`
	Returns a flag indicating whether the annotation is retained More...

unsafe NXOpen.Annotations.LeaderOrientation	LeaderOrientation `[get, set]`
	Returns or sets the leader orientation for the annotation. More...

unsafe int	NumberOfAssociativities `[get]`
	Returns the number of associativities for the annotation. More...

unsafe bool	ParallelToScreen `[get, set]`
	Returns or sets the PMI parallel to screen setting More...

unsafe bool	Suppressed `[get]`
	Returns the flag indicating whether the annotation is suppressed More...

Detailed Description

Represents a simple drafting aid.

In all edit methods, the changes are not applied to the system until an update is performed. An update can be performed by calling NXOpen.Update.DoUpdate .

This is an abstract class.

Created in NX3.0.0

Member Function Documentation

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

inline

Returns the drafting aid's text

Created in NX3.0.0

License requirements: None.

Returns

unsafe NXOpen.Annotations.UserSymbolPreferences NXOpen.Annotations.SimpleDraftingAid.GetUserSymbolPreferences ( )

inline

Returns the user symbol preferences

Created in NX3.0.0

License requirements: None.

Returns

unsafe void NXOpen.Annotations.SimpleDraftingAid.GetUserSymbolSize	(	out NXOpen.Annotations.UserSymbolPreferences.SizeType	sizeType,
		out double	lengthOrScale,
		out double	heightOrAspectRatio
	)

inline

Gets the user symbol size

Created in NX3.0.0

License requirements: None.

Parameters

sizeType	Whether the length and height or scale and aspect ratio is used
lengthOrScale
heightOrAspectRatio

unsafe void NXOpen.Annotations.SimpleDraftingAid.SetText ( string[] lines )

inline

Sets the drafting aid's text.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated. NOTE: This method may require an additional update for correct symbol display.

Created in NX3.0.0

License requirements: drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

lines the new text

unsafe void NXOpen.Annotations.SimpleDraftingAid.SetUserSymbolPreferences ( NXOpen.Annotations.UserSymbolPreferences usymPrefs )

inline

Sets the user symbol preferences.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements: drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

usymPrefs

unsafe void NXOpen.Annotations.SimpleDraftingAid.SetUserSymbolSize	(	NXOpen.Annotations.UserSymbolPreferences.SizeType	sizeType,
		double	lengthOrScale,
		double	heightOrAspectRatio
	)

inline

Sets the user symbol size.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Created in NX3.0.0

License requirements: drafting ("DRAFTING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters

sizeType	Whether to use length and height or scale and aspect ratio
lengthOrScale
heightOrAspectRatio

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

Annotations_SimpleDraftingAid.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation