MasterSymbolBuilder Class

class NXOpen.Annotations.MasterSymbolBuilder

Bases: NXOpen.Builder

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

New in version NX7.5.0.

Properties

Property	Description
AnchorPoint	Returns or sets the anchor point
Contents	Returns the select object
ImageCapture	Returns the image capture builder
ImageName	Returns or sets the symbol image name
ItemName	Returns or sets the Item Name, valid in team center
ItemNumber	Returns or sets the item number, valid in team center
NoteList	Returns the note list
PartFileName	Returns or sets the part file name
Revision	Returns or sets the revision, valid in team center
SymbolName	Returns or sets the JA method support for accessing and setting Symbol Name value
Tag	Returns the Tag for this object.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CreateNewListItem	Create Master Symbol list item builder
Destroy	Deletes the builder, and cleans up any objects created by the builder.
EditImage	Changes symbol image
GenerateItemNumber	Item number assign button.
GenerateRevision	Revision assign button, This will generate the revision number, valid in team center
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetLeaderAttachmentPoint	Getting Leader attachment point from builder side
GetMultilineString	Returns the multiple notes for a given Text Type.
GetObject	Returns the object currently being edited by this builder.
GetPartOperationCreateBuilder	Gets NXOpen.PDM.PartOperationBuilder
Rename	Renames symbol
SetIsPartSymbol	Sets if it is part symbol
SetLeaderAttachmentPoint	Setting Leader attachment point on builder side
SetPartOperationCreateBuilder	Sets NXOpen.PDM.PartOperationBuilder
SetPath	Setting Path retrieved from Global method at builder side
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

MasterSymbolBuilderLeaderAttachmentType Enumeration

The Enum for Attachment options

Property Detail

AnchorPoint

MasterSymbolBuilder.AnchorPoint

Returns or sets the anchor point

-------------------------------------

Getter Method

Signature AnchorPoint

Returns: Return type:NXOpen.Point

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AnchorPoint

Parameters:anchorPoint (NXOpen.Point) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Contents

MasterSymbolBuilder.Contents

Returns the select object

-------------------------------------

Getter Method

Signature Contents

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX7.5.0.

License requirements: None.

ImageCapture

MasterSymbolBuilder.ImageCapture

Returns the image capture builder

-------------------------------------

Getter Method

Signature ImageCapture

Returns: Return type:NXOpen.Gateway.ImageCaptureBuilder

New in version NX7.5.0.

License requirements: None.

ImageName

MasterSymbolBuilder.ImageName

Returns or sets the symbol image name

-------------------------------------

Getter Method

Signature ImageName

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageName

Parameters:imageName (str) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

ItemName

MasterSymbolBuilder.ItemName

Returns or sets the Item Name, valid in team center

-------------------------------------

Getter Method

Signature ItemName

Returns: Return type:str

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: None.

-------------------------------------

Setter Method

Signature ItemName

Parameters:itemName (str) –

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: drafting (“DRAFTING”)

ItemNumber

MasterSymbolBuilder.ItemNumber

Returns or sets the item number, valid in team center

-------------------------------------

Getter Method

Signature ItemNumber

Returns: Return type:str

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: None.

-------------------------------------

Setter Method

Signature ItemNumber

Parameters:itemNumber (str) –

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: drafting (“DRAFTING”)

NoteList

MasterSymbolBuilder.NoteList

Returns the note list

-------------------------------------

Getter Method

Signature NoteList

Returns: Return type:NXOpen.NXObjectList

New in version NX7.5.0.

License requirements: None.

PartFileName

MasterSymbolBuilder.PartFileName

Returns or sets the part file name

-------------------------------------

Getter Method

Signature PartFileName

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PartFileName

Parameters:partFileName (str) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Revision

MasterSymbolBuilder.Revision

Returns or sets the revision, valid in team center

-------------------------------------

Getter Method

Signature Revision

Returns: Return type:str

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: None.

-------------------------------------

Setter Method

Signature Revision

Parameters:revision (str) –

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.PDM.PartOperationCreateBuilder instead.

License requirements: drafting (“DRAFTING”)

SymbolName

MasterSymbolBuilder.SymbolName

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

-------------------------------------

Getter Method

Signature SymbolName

Returns: Return type:str

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SymbolName

Parameters:symbolName (str) –

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Method Detail

CreateNewListItem

MasterSymbolBuilder.CreateNewListItem

Create Master Symbol list item builder

Signature CreateNewListItem(noteTag, notes)

Parameters:

• noteTag (NXOpen.Annotations.Annotation) –
• notes (list of str) – name of the solution

Returns:

Return type:

NXOpen.Annotations.MasterSymbolListItemBuilder

New in version NX7.5.0.

License requirements: None.

EditImage

MasterSymbolBuilder.EditImage

Changes symbol image

Signature EditImage(currentSymbolTag, newImageName)

Parameters:

• currentSymbolTag (NXOpen.Annotations.MasterSymbol) – symbol Tag
• newImageName (str) – New image name

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

GenerateItemNumber

MasterSymbolBuilder.GenerateItemNumber

Item number assign button.

This will generate the item number, valid in team center

Signature GenerateItemNumber()

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.Annotations.MasterSymbolBuilder.ItemNumber() instead.

License requirements: drafting (“DRAFTING”)

GenerateRevision

MasterSymbolBuilder.GenerateRevision

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

Signature GenerateRevision()

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.Annotations.MasterSymbolBuilder.Revision() instead.

License requirements: drafting (“DRAFTING”)

GetLeaderAttachmentPoint

MasterSymbolBuilder.GetLeaderAttachmentPoint

Getting Leader attachment point from builder side

Signature GetLeaderAttachmentPoint(attachmentType)

Parameters:attachmentType (NXOpen.Annotations.MasterSymbolBuilderLeaderAttachmentType) – Attachment type either of left or right Returns: Return type:NXOpen.Point

New in version NX7.5.0.

License requirements: None.

GetMultilineString

MasterSymbolBuilder.GetMultilineString

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

Signature GetMultilineString()

Returns:Multiple notes as Output Return type:list of str

New in version NX7.5.0.

License requirements: None.

GetPartOperationCreateBuilder

MasterSymbolBuilder.GetPartOperationCreateBuilder

Gets NXOpen.PDM.PartOperationBuilder

Signature GetPartOperationCreateBuilder()

Returns: Return type:NXOpen.PDM.PartOperationCreateBuilder

New in version NX10.0.0.

License requirements: None.

Rename

MasterSymbolBuilder.Rename

Renames symbol

Signature Rename(currentSymbolTag, newSymbolName)

Parameters:

• currentSymbolTag (NXOpen.Annotations.MasterSymbol) – symbol Tag
• newSymbolName (str) – New symbol name

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

SetIsPartSymbol

MasterSymbolBuilder.SetIsPartSymbol

Sets if it is part symbol

Signature SetIsPartSymbol(isPartSymbol)

Parameters:isPartSymbol (bool) – True If it is part symbol

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

SetLeaderAttachmentPoint

MasterSymbolBuilder.SetLeaderAttachmentPoint

Setting Leader attachment point on builder side

Signature SetLeaderAttachmentPoint(attachmentType, leaderAttachmentPoint)

Parameters:

• attachmentType (NXOpen.Annotations.MasterSymbolBuilderLeaderAttachmentType) – Attachment type either of left or right
• leaderAttachmentPoint (NXOpen.Point) – Attachment point

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

SetPartOperationCreateBuilder

MasterSymbolBuilder.SetPartOperationCreateBuilder

Sets NXOpen.PDM.PartOperationBuilder

Signature SetPartOperationCreateBuilder(partOperationBuilder)

Parameters:partOperationBuilder (NXOpen.PDM.PartOperationCreateBuilder) –

New in version NX10.0.0.

License requirements: drafting (“DRAFTING”)

SetPath

MasterSymbolBuilder.SetPath

Setting Path retrieved from Global method at builder side

Signature SetPath(path)

Parameters:path (str) – location of symbol

New in version NX7.5.0.

License requirements: drafting (“DRAFTING”)

Validate

MasterSymbolBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.