Represents a base custom symbol More...

Inheritance diagram for NXOpen.Annotations.BaseCustomSymbol:

Public Member Functions
unsafe void	AddBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers)
	Adds the business modifiers. More...

unsafe void	AddLeader (NXOpen.Annotations.LeaderBundle leader)
	Adds leaders to the custom symbol. More...

unsafe void	FlipSymbol (NXOpen.Annotations.FlipOption flipOption)
	Flips the custom symbol horizontally/vertically. More...

unsafe NXOpen.Point	GetAnchor ()
	Returns the master custom symbol anchor point More...

unsafe NXOpen.Annotations.AssociatedObject	GetAssociatedObject ()
	Returns the associated object More...

unsafe NXOpen.Annotations.BusinessModifier[]	GetBusinessModifiers ()
	Returns the business modifiers More...

unsafe NXOpen.Annotations.AssociatedObject	GetSharedAssociatedObject ()
	Returns the shared associated objects More...

unsafe NXOpen.Annotations.CustomSymbolData	GetSymbolData ()
	Returns the custom symbol data More...

unsafe void	RemoveLeader (int nthLeader)
	Removes leader from the custom symbol. More...

unsafe void	ReplaceSymbol (string name, string path, bool isPartSymbol)
	Replace custom symbol with the given master symbol name and path. More...

unsafe void	SetAnchor (NXOpen.Point anchorPoint)
	Sets the master custom symbol anchor point. More...

unsafe void	SetAssociatedObject (NXOpen.Annotations.AssociatedObject assocObj)
	Sets the associated object. More...

unsafe void	SetBusinessModifiers (NXOpen.Annotations.BusinessModifier[] businessModifiers)
	Sets the business modifiers. More...

unsafe void	SetSymbolData (NXOpen.Annotations.CustomSymbolData data)
	Sets the custom symbol data. More...

unsafe void	SynchronizeSymbol ()
	Synchronize associative custom symbol. More...

unsafe void	UpdateFromRule ()
	Updates the specified symbol from the KF rule. More...

unsafe void	UpdateSymbolGeometry (NXOpen.Point3d origin, double scale, double angle)
	Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed. More...

Properties
unsafe int	Index `[get, set]`
	Returns or sets the index. More...

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

unsafe bool	IsWaveLinked `[get]`
	Returns a flag indicating whether the pmi is wave linked More...

unsafe NXOpen.Annotations.Annotation	LinkSource `[get]`
	Returns the source pmi of linked pmi which is linked via wave or mirror. More...

unsafe string	SymbolName `[get]`
	Returns the symbol name. More...

Properties inherited from NXOpen.Annotations.IPmi
int	Index `[get, set]`
	Returns or sets the index. More...

bool	IsMirrored `[get]`
	Returns a flag indicating whether the annotation is mirrored More...

bool	IsWaveLinked `[get]`
	Returns a flag indicating whether the pmi is wave linked More...

NXOpen.Annotations.Annotation	LinkSource `[get]`
	Returns the source pmi of linked pmi which is linked via wave or mirror. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. 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...

Detailed Description

Represents a base custom symbol

This is an abstract class and cannot be directly instantiated

Created in NX4.0.0

Member Function Documentation

unsafe void NXOpen.Annotations.BaseCustomSymbol.AddBusinessModifiers ( NXOpen.Annotations.BusinessModifier[] businessModifiers )

inline

Adds the business modifiers.

Created in NX12.0.0

License requirements: geometric_tol ("GDT")

Parameters

businessModifiers List of new business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseCustomSymbol.AddLeader ( NXOpen.Annotations.LeaderBundle leader )

inline

Adds leaders to the custom symbol.

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 NX5.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

leader Specifies the leaders to add

unsafe void NXOpen.Annotations.BaseCustomSymbol.FlipSymbol ( NXOpen.Annotations.FlipOption flipOption )

inline

Flips the custom symbol horizontally/vertically.

This is only available when editing. This option is unavailable for symbols with leaders. 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 NX4.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

flipOption New flip option

unsafe NXOpen.Point NXOpen.Annotations.BaseCustomSymbol.GetAnchor ( )

inline

Returns the master custom symbol anchor point

Created in NX4.0.0

License requirements: None.

Returns: Custom Symbol Anchor Point

unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseCustomSymbol.GetAssociatedObject ( )

inline

Returns the associated object

Created in NX4.0.0

License requirements: None.

Returns: Associated object

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.BusinessModifier [] NXOpen.Annotations.BaseCustomSymbol.GetBusinessModifiers ( )

inline

Returns the business modifiers

Created in NX4.0.0

License requirements: None.

Returns: List of business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.AssociatedObject NXOpen.Annotations.BaseCustomSymbol.GetSharedAssociatedObject ( )

inline

Returns the shared associated objects

Created in NX8.5.0

License requirements: None.

Returns: Shared associated objects

Implements NXOpen.Annotations.IPmi.

unsafe NXOpen.Annotations.CustomSymbolData NXOpen.Annotations.BaseCustomSymbol.GetSymbolData ( )

inline

Returns the custom symbol data

Created in NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.

License requirements: None.

Returns: Custom symbol data

unsafe void NXOpen.Annotations.BaseCustomSymbol.RemoveLeader ( int nthLeader )

inline

Removes leader from the custom symbol.

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 NX5.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

nthLeader Specifies which leader to remove

unsafe void NXOpen.Annotations.BaseCustomSymbol.ReplaceSymbol	(	string	name,
		string	path,
		bool	isPartSymbol
	)

inline

Replace custom symbol with the given master symbol name and path.

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 NX8.0.0

License requirements: drafting ("DRAFTING")

Parameters

name	Master symbol name
path	Master symbol path
isPartSymbol	true if part symbol else false

unsafe void NXOpen.Annotations.BaseCustomSymbol.SetAnchor ( NXOpen.Point anchorPoint )

inline

Sets the master custom symbol anchor point.

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 NX4.0.0

License requirements: None.

Parameters

anchorPoint Custom Symbol Anchor Point

unsafe void NXOpen.Annotations.BaseCustomSymbol.SetAssociatedObject ( NXOpen.Annotations.AssociatedObject assocObj )

inline

Sets the associated object.

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 NX4.0.0

License requirements: geometric_tol ("GDT")

Parameters

assocObj New associated object

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseCustomSymbol.SetBusinessModifiers ( NXOpen.Annotations.BusinessModifier[] businessModifiers )

inline

Sets the business modifiers.

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 NX4.0.0

License requirements: geometric_tol ("GDT")

Parameters

businessModifiers List of new business modifiers

Implements NXOpen.Annotations.IPmi.

unsafe void NXOpen.Annotations.BaseCustomSymbol.SetSymbolData ( NXOpen.Annotations.CustomSymbolData data )

inline

Sets the custom symbol data.

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 NX4.0.0

Deprecated in NX9.0.0. Use NXOpen.Annotations.DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen.Annotations.PmiCustomSymbolBuilder for PMI Custom Symbol objects.

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

data	New custom symbol data

unsafe void NXOpen.Annotations.BaseCustomSymbol.SynchronizeSymbol ( )

inline

Synchronize associative custom symbol.

Created in NX8.0.0

License requirements: drafting ("DRAFTING")

unsafe void NXOpen.Annotations.BaseCustomSymbol.UpdateFromRule ( )

inline

Updates the specified symbol from the KF rule.

The changes are not applied till an update is performed by calling Update.DoUpdate .

Created in NX8.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

unsafe void NXOpen.Annotations.BaseCustomSymbol.UpdateSymbolGeometry	(	NXOpen.Point3d	origin,
		double	scale,
		double	angle
	)

inline

Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed.

Created in NX5.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

origin	New origin
scale	New scale
angle	New angle

Property Documentation

unsafe int NXOpen.Annotations.BaseCustomSymbol.Index

getset

Returns or sets the index.

It is a unique integer assigned to a PMI object.

NOTE: The set 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 NX4.0.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.BaseCustomSymbol.IsMirrored

get

Returns a flag indicating whether the annotation is mirrored

Created in NX8.5.0

License requirements: None.

unsafe bool NXOpen.Annotations.BaseCustomSymbol.IsWaveLinked

get

Returns a flag indicating whether the pmi is wave linked

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Annotations.Annotation NXOpen.Annotations.BaseCustomSymbol.LinkSource

get

Returns the source pmi of linked pmi which is linked via wave or mirror.

Created in NX1847.0.0

License requirements: None.

unsafe string NXOpen.Annotations.BaseCustomSymbol.SymbolName

get

Returns the symbol name.

Created in NX6.0.0

License requirements: None.

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

Annotations_BaseCustomSymbol.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation