Represents a base Builder for Drafting and PMI Custom Symbol More...

Inheritance diagram for NXOpen.Annotations.BaseCustomSymbolBuilder:

Public Types
enum	AnnotationPreferences { UseCurrent, UseDefinition }
	Enum for Annotation Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference and NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference to set the annotation preferences for a symbol More...

enum	GeometryPreferences { UseCurrent, UseDefinition }
	Enum for Geometric Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference and NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference to set the geometric preferences for a symbol More...

Public Member Functions
unsafe string[]	GetArbitraryNoteTitle ()
	Returns the arbitrary note value in an array. More...

unsafe NXOpen.Annotations.BaseCustomSymbol	GetSymbol ()
	Returns the custom symbol More...

unsafe void	SelectPartSymbol (string name, string path)
	Selects part custom symbol More...

unsafe void	SelectSymbol (string name)
	Selects custom symbol More...

unsafe void	SelectText (int index)
	Selects the node index of custom symbol text More...

unsafe void	SetArbitraryNoteTitle (string[] arbitraryNoteTitle)
	Sets the arbitrary note value. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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.Expression	Angle `[get]`
	Returns the angle More...

unsafe NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreferences	AnnotationPreference `[get, set]`
	Returns or sets the enum annot pref. More...

unsafe int	ControlledNoteTitle `[get, set]`
	Returns or sets the controlled note title More...

unsafe NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreferences	GeometryPreference `[get, set]`
	Returns or sets the enum geom pref. More...

unsafe bool	HorizontalFlip `[get, set]`
	Returns or sets the horizontal flip More...

unsafe int	Integer `[get, set]`
	Returns or sets the integer value of selected text More...

unsafe bool	IsPartSymbol `[get, set]`
	Returns or sets the is part symbol. More...

unsafe NXOpen.Annotations.LeaderBuilder	Leader `[get]`
	Returns the NXOpen.Annotations.LeaderBuilder for the annotation More...

unsafe bool	LockStatus `[get, set]`
	Returns or sets the get symbol lock property More...

unsafe string	MasterSymbolName `[get, set]`
	Returns or sets the master symbol Name. More...

unsafe string	MasterSymbolPath `[get, set]`
	Returns or sets the master symbol path. More...

unsafe NXOpen.Annotations.OriginBuilder	Origin `[get]`
	Returns the origin More...

unsafe string	PartiallyControlledNoteTitle `[get, set]`
	Returns or sets the partially controlled note title More...

unsafe double	Real `[get, set]`
	Returns or sets the real value of selected text More...

unsafe NXOpen.Expression	Scale `[get]`
	Returns the scale More...

unsafe bool	SmashSymbol `[get, set]`
	Returns or sets the smash symbol More...

unsafe NXOpen.Annotations.StyleBuilder	Style `[get]`
	Returns the style builder More...

unsafe NXOpen.Annotations.MasterSymbolListItemBuilderList	Texts `[get]`
	Returns the texts More...

unsafe bool	VerticalFlip `[get, set]`
	Returns or sets the vertical flip More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. 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 base Builder for Drafting and PMI Custom Symbol

This is an abstract class, and cannot be instantiated.

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreferences

Enum for Annotation Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference and NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference to set the annotation preferences for a symbol

Enumerator
UseCurrent	Current preferences
UseDefinition	Defined preferences

enum NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreferences

Enum for Geometric Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference and NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference to set the geometric preferences for a symbol

Enumerator
UseCurrent	Current preferences
UseDefinition	Defined preferences

Member Function Documentation

unsafe string [] NXOpen.Annotations.BaseCustomSymbolBuilder.GetArbitraryNoteTitle ( )

inline

Returns the arbitrary note value in an array.

This should be used only after NXOpen.Annotations.BaseCustomSymbolBuilder.SelectText is used

Created in NX7.5.0

License requirements: None.

Returns

unsafe NXOpen.Annotations.BaseCustomSymbol NXOpen.Annotations.BaseCustomSymbolBuilder.GetSymbol ( )

inline

Returns the custom symbol

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Returns: The custom symbol

unsafe void NXOpen.Annotations.BaseCustomSymbolBuilder.SelectPartSymbol	(	string	name,
		string	path
	)

inline

Selects part custom symbol

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

name	Name of symbol
path	PartSymbol full Path

unsafe void NXOpen.Annotations.BaseCustomSymbolBuilder.SelectSymbol ( string name )

inline

Selects custom symbol

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

name	Name of symbol

unsafe void NXOpen.Annotations.BaseCustomSymbolBuilder.SelectText ( int index )

inline

Selects the node index of custom symbol text

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

index index of selected text

unsafe void NXOpen.Annotations.BaseCustomSymbolBuilder.SetArbitraryNoteTitle ( string[] arbitraryNoteTitle )

inline

Sets the arbitrary note value.

This should be used only after NXOpen.Annotations.BaseCustomSymbolBuilder.SelectText is used

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

arbitraryNoteTitle

Property Documentation

unsafe NXOpen.Expression NXOpen.Annotations.BaseCustomSymbolBuilder.Angle

get

Returns the angle

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreferences NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference

getset

Returns or sets the enum annot pref.

This is used while creating the object and it is non-editable property

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe int NXOpen.Annotations.BaseCustomSymbolBuilder.ControlledNoteTitle

getset

Returns or sets the controlled note title

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreferences NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference

getset

Returns or sets the enum geom pref.

This is used while creating the object and it is non-editable property

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.BaseCustomSymbolBuilder.HorizontalFlip

getset

Returns or sets the horizontal flip

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe int NXOpen.Annotations.BaseCustomSymbolBuilder.Integer

getset

Returns or sets the integer value of selected text

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe bool NXOpen.Annotations.BaseCustomSymbolBuilder.IsPartSymbol

getset

Returns or sets the is part symbol.

This is used while creating the object and it is non-editable property

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.Annotations.LeaderBuilder NXOpen.Annotations.BaseCustomSymbolBuilder.Leader

get

Returns the NXOpen.Annotations.LeaderBuilder for the annotation

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.Annotations.BaseCustomSymbolBuilder.LockStatus

getset

Returns or sets the get symbol lock property

Created in NX8.0.0

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.BaseCustomSymbolBuilder.MasterSymbolName

getset

Returns or sets the master symbol Name.

This is used while creating the object and it is non-editable property

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.BaseCustomSymbolBuilder.MasterSymbolPath

getset

Returns or sets the master symbol path.

This is used while creating the object and it is non-editable property

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.Annotations.OriginBuilder NXOpen.Annotations.BaseCustomSymbolBuilder.Origin

get

Returns the origin

Created in NX7.5.0

License requirements: None.

unsafe string NXOpen.Annotations.BaseCustomSymbolBuilder.PartiallyControlledNoteTitle

getset

Returns or sets the partially controlled note title

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe double NXOpen.Annotations.BaseCustomSymbolBuilder.Real

getset

Returns or sets the real value of selected text

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.Expression NXOpen.Annotations.BaseCustomSymbolBuilder.Scale

get

Returns the scale

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.Annotations.BaseCustomSymbolBuilder.SmashSymbol

getset

Returns or sets the smash symbol

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.Annotations.StyleBuilder NXOpen.Annotations.BaseCustomSymbolBuilder.Style

get

Returns the style builder

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Annotations.MasterSymbolListItemBuilderList NXOpen.Annotations.BaseCustomSymbolBuilder.Texts

get

Returns the texts

Created in NX7.5.0

License requirements: None.

unsafe bool NXOpen.Annotations.BaseCustomSymbolBuilder.VerticalFlip

getset

Returns or sets the vertical flip

Created in NX7.5.0

License requirements to get this property: None.

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

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

Annotations_BaseCustomSymbolBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation