Represents a Builder for MasterSymbol functionality More...

Inheritance diagram for NXOpen.Annotations.MasterSymbolBuilder:

Public Types
enum	LeaderAttachmentType { Left, Right }
	The Enum for Attachment options More...

Public Member Functions
unsafe NXOpen.Annotations.MasterSymbolListItemBuilder	CreateNewListItem (NXOpen.Annotations.Annotation noteTag, string[] notes)
	Create Master Symbol list item builder More...

unsafe void	EditImage (NXOpen.Annotations.MasterSymbol currentSymbolTag, string newImageName)
	Changes symbol image More...

unsafe void	GenerateItemNumber ()
	Item number assign button. More...

unsafe void	GenerateRevision ()
	Revision assign button, This will generate the revision number, valid in team center More...

unsafe NXOpen.Point	GetLeaderAttachmentPoint (NXOpen.Annotations.MasterSymbolBuilder.LeaderAttachmentType attachmentType)
	Getting Leader attachment point from builder side More...

unsafe string[]	GetMultilineString ()
	Returns the multiple notes for a given Text Type. More...

unsafe NXOpen.PDM.PartOperationCreateBuilder	GetPartOperationCreateBuilder ()
	Gets NXOpen.PDM.PartOperationBuilder More...

unsafe void	Rename (NXOpen.Annotations.MasterSymbol currentSymbolTag, string newSymbolName)
	Renames symbol More...

unsafe void	SetIsPartSymbol (bool isPartSymbol)
	Sets if it is part symbol More...

unsafe void	SetLeaderAttachmentPoint (NXOpen.Annotations.MasterSymbolBuilder.LeaderAttachmentType attachmentType, NXOpen.Point leaderAttachmentPoint)
	Setting Leader attachment point on builder side More...

unsafe void	SetPartOperationCreateBuilder (NXOpen.PDM.PartOperationCreateBuilder partOperationBuilder)
	Sets NXOpen.PDM.PartOperationBuilder More...

unsafe void	SetPath (string path)
	Setting Path retrieved from Global method at builder side 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.Point	AnchorPoint `[get, set]`
	Returns or sets the anchor point More...

unsafe NXOpen.SelectNXObjectList	Contents `[get]`
	Returns the select object More...

unsafe NXOpen.Gateway.ImageCaptureBuilder	ImageCapture `[get]`
	Returns the image capture builder More...

unsafe string	ImageName `[get, set]`
	Returns or sets the symbol image name More...

unsafe string	ItemName `[get, set]`
	Returns or sets the Item Name, valid in team center More...

unsafe string	ItemNumber `[get, set]`
	Returns or sets the item number, valid in team center More...

unsafe NXOpen.NXObjectList	NoteList `[get]`
	Returns the note list More...

unsafe string	PartFileName `[get, set]`
	Returns or sets the part file name More...

unsafe string	Revision `[get, set]`
	Returns or sets the revision, valid in team center More...

unsafe string	SymbolName `[get, set]`
	Returns or sets the JA method support for accessing and setting Symbol Name value 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 Builder for MasterSymbol functionality

To create a new instance of this class, use NXOpen.Annotations.CustomSymbolCollection.CreateMasterSymbolBuilder

Default values.

Property

Value

ImageCapture.CaptureMethod

GraphicsArea

ImageCapture.Format

Bmp

ImageCapture.Size

Pixels64

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.Annotations.MasterSymbolBuilder.LeaderAttachmentType

The Enum for Attachment options

Enumerator
Left	Left Attachment
Right	Right Attachment

Member Function Documentation

unsafe NXOpen.Annotations.MasterSymbolListItemBuilder NXOpen.Annotations.MasterSymbolBuilder.CreateNewListItem	(	NXOpen.Annotations.Annotation	noteTag,
		string[]	notes
	)

inline

Create Master Symbol list item builder

Created in NX7.5.0

License requirements: None.

Parameters

noteTag
notes	name of the solution

Returns

unsafe void NXOpen.Annotations.MasterSymbolBuilder.EditImage	(	NXOpen.Annotations.MasterSymbol	currentSymbolTag,
		string	newImageName
	)

inline

Changes symbol image

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

currentSymbolTag	symbol Tag
newImageName	New image name

unsafe void NXOpen.Annotations.MasterSymbolBuilder.GenerateItemNumber ( )

inline

Item number assign button.

This will generate the item number, valid in team center

Created in NX7.5.0

Deprecated in NX10.0.0. Use NXOpen.Annotations.MasterSymbolBuilder.ItemNumber instead.

License requirements: drafting ("DRAFTING")

unsafe void NXOpen.Annotations.MasterSymbolBuilder.GenerateRevision ( )

inline

Revision assign button, This will generate the revision number, valid in team center

Created in NX7.5.0

Deprecated in NX10.0.0. Use NXOpen.Annotations.MasterSymbolBuilder.Revision instead.

License requirements: drafting ("DRAFTING")

unsafe NXOpen.Point NXOpen.Annotations.MasterSymbolBuilder.GetLeaderAttachmentPoint ( NXOpen.Annotations.MasterSymbolBuilder.LeaderAttachmentType attachmentType )

inline

Getting Leader attachment point from builder side

Created in NX7.5.0

License requirements: None.

Parameters

attachmentType Attachment type either of left or right

Returns

unsafe string [] NXOpen.Annotations.MasterSymbolBuilder.GetMultilineString ( )

inline

Returns the multiple notes for a given Text Type.

This property is valid if NXOpen.Annotations.MasterSymbolListItemBuilder.TextType is either of controlled, partially controlled or arbitory

Created in NX7.5.0

License requirements: None.

Returns: Multiple notes as Output

unsafe NXOpen.PDM.PartOperationCreateBuilder NXOpen.Annotations.MasterSymbolBuilder.GetPartOperationCreateBuilder ( )

inline

Gets NXOpen.PDM.PartOperationBuilder

Created in NX10.0.0

License requirements: None.

Returns

unsafe void NXOpen.Annotations.MasterSymbolBuilder.Rename	(	NXOpen.Annotations.MasterSymbol	currentSymbolTag,
		string	newSymbolName
	)

inline

Renames symbol

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

currentSymbolTag	symbol Tag
newSymbolName	New symbol name

unsafe void NXOpen.Annotations.MasterSymbolBuilder.SetIsPartSymbol ( bool isPartSymbol )

inline

Sets if it is part symbol

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

isPartSymbol True If it is part symbol

unsafe void NXOpen.Annotations.MasterSymbolBuilder.SetLeaderAttachmentPoint	(	NXOpen.Annotations.MasterSymbolBuilder.LeaderAttachmentType	attachmentType,
		NXOpen.Point	leaderAttachmentPoint
	)

inline

Setting Leader attachment point on builder side

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

attachmentType	Attachment type either of left or right
leaderAttachmentPoint	Attachment point

unsafe void NXOpen.Annotations.MasterSymbolBuilder.SetPartOperationCreateBuilder ( NXOpen.PDM.PartOperationCreateBuilder partOperationBuilder )

inline

Sets NXOpen.PDM.PartOperationBuilder

Created in NX10.0.0

License requirements: drafting ("DRAFTING")

Parameters

partOperationBuilder

unsafe void NXOpen.Annotations.MasterSymbolBuilder.SetPath ( string path )

inline

Setting Path retrieved from Global method at builder side

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

path	location of symbol

Property Documentation

unsafe NXOpen.Point NXOpen.Annotations.MasterSymbolBuilder.AnchorPoint

getset

Returns or sets the anchor point

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe NXOpen.SelectNXObjectList NXOpen.Annotations.MasterSymbolBuilder.Contents

get

Returns the select object

Created in NX7.5.0

License requirements: None.

unsafe NXOpen.Gateway.ImageCaptureBuilder NXOpen.Annotations.MasterSymbolBuilder.ImageCapture

get

Returns the image capture builder

Created in NX7.5.0

License requirements: None.

unsafe string NXOpen.Annotations.MasterSymbolBuilder.ImageName

getset

Returns or sets the symbol image name

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.MasterSymbolBuilder.ItemName

getset

Returns or sets the Item Name, valid in team center

Created in NX7.5.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.MasterSymbolBuilder.ItemNumber

getset

Returns or sets the item number, valid in team center

Created in NX7.5.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements to get this property: None.

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

unsafe NXOpen.NXObjectList NXOpen.Annotations.MasterSymbolBuilder.NoteList

get

Returns the note list

Created in NX7.5.0

License requirements: None.

unsafe string NXOpen.Annotations.MasterSymbolBuilder.PartFileName

getset

Returns or sets the part file name

Created in NX7.5.0

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.MasterSymbolBuilder.Revision

getset

Returns or sets the revision, valid in team center

Created in NX7.5.0

Deprecated in NX10.0.0. Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements to get this property: None.

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

unsafe string NXOpen.Annotations.MasterSymbolBuilder.SymbolName

getset

Returns or sets the JA method support for accessing and setting Symbol Name value

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_MasterSymbolBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation