NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Annotations::MasterSymbolBuilder Class Reference

Represents a Builder for MasterSymbol functionality
To create a new instance of this class, use Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder
Default values. More...

Inheritance diagram for NXOpen::Annotations::MasterSymbolBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  LeaderAttachmentType { LeaderAttachmentTypeLeft, LeaderAttachmentTypeRight }
 The Enum for Attachment options. More...

Public Member Functions

NXOpen::PointAnchorPoint ()
 Returns the anchor point
Created in NX7.5.0.
NXOpen::SelectNXObjectListContents ()
 Returns the select object
Created in NX7.5.0.
NXOpen::Annotations::MasterSymbolListItemBuilderCreateNewListItem (NXOpen::Annotations::Annotation *noteTag, const std::vector< NXString > &notes)
 Create Master Symbol list item builder.
void EditImage (NXOpen::Annotations::MasterSymbol *currentSymbolTag, const NXString &newImageName)
 Changes symbol image
Created in NX7.5.0.
void GenerateItemNumber ()
 Item number assign button.
void GenerateRevision ()
 Revision assign button, This will generate the revision number, valid in team center
Created in NX7.5.0.
NXOpen::PointGetLeaderAttachmentPoint (NXOpen::Annotations::MasterSymbolBuilder::LeaderAttachmentType attachmentType)
 Getting Leader attachment point from builder side.
std::vector< NXStringGetMultilineString ()
 Returns the multiple notes for a given Text Type.
NXOpen::Gateway::ImageCaptureBuilderImageCapture ()
 Returns the image capture builder
Created in NX7.5.0.
NXString ImageName ()
 Returns the symbol image name
Created in NX7.5.0.
NXString ItemName ()
 Returns the Item Name, valid in team center
Created in NX7.5.0.
NXString ItemNumber ()
 Returns the item number, valid in team center
Created in NX7.5.0.
NXOpen::NXObjectListNoteList ()
 Returns the note list
Created in NX7.5.0.
NXString PartFileName ()
 Returns the part file name
Created in NX7.5.0.
void Rename (NXOpen::Annotations::MasterSymbol *currentSymbolTag, const NXString &newSymbolName)
 Renames symbol
Created in NX7.5.0.
NXString Revision ()
 Returns the revision, valid in team center
Created in NX7.5.0.
void SetAnchorPoint (NXOpen::Point *anchorPoint)
 Sets the anchor point
Created in NX7.5.0.
void SetImageName (const NXString &imageName)
 Sets the symbol image name
Created in NX7.5.0.
void SetIsPartSymbol (bool isPartSymbol)
 Sets if it is part symbol
Created in NX7.5.0.
void SetItemName (const NXString &itemName)
 Sets the Item Name, valid in team center
Created in NX7.5.0.
void SetItemNumber (const NXString &itemNumber)
 Sets the item number, valid in team center
Created in NX7.5.0.
void SetLeaderAttachmentPoint (NXOpen::Annotations::MasterSymbolBuilder::LeaderAttachmentType attachmentType, NXOpen::Point *leaderAttachmentPoint)
 Setting Leader attachment point on builder side
Created in NX7.5.0.
void SetPartFileName (const NXString &partFileName)
 Sets the part file name
Created in NX7.5.0.
void SetPath (const NXString &path)
 Setting Path retrieved from Global method at builder side
Created in NX7.5.0.
void SetRevision (const NXString &revision)
 Sets the revision, valid in team center
Created in NX7.5.0.
void SetSymbolName (const NXString &symbolName)
 Sets the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.
NXString SymbolName ()
 Returns the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.

Detailed Description

Represents a Builder for MasterSymbol functionality
To create a new instance of this class, use Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder
Default values.

Property Value

ImageCapture.CaptureMethod

GraphicsArea

ImageCapture.Format

Bmp

ImageCapture.Size

Pixels64


Created in NX7.5.0.


Member Enumeration Documentation

The Enum for Attachment options.

Enumerator:
LeaderAttachmentTypeLeft 

Left Attachment.

LeaderAttachmentTypeRight 

Right Attachment.


Member Function Documentation

Returns the anchor point
Created in NX7.5.0.



License requirements : None

Returns the select object
Created in NX7.5.0.



License requirements : None

Create Master Symbol list item builder.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
noteTagnotetag
notesname of the solution

Changes symbol image
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
currentSymbolTagsymbol Tag
newImageNameNew image name

Item number assign button.

This will generate the item number, valid in team center
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Revision assign button, This will generate the revision number, valid in team center
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Getting Leader attachment point from builder side.

Returns:

Created in NX7.5.0.

License requirements : None
Parameters:
attachmentTypeAttachment type either of left or right

Returns the multiple notes for a given Text Type.

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

Returns:
Multiple notes as Output
Created in NX7.5.0.

License requirements : None

Returns the image capture builder
Created in NX7.5.0.



License requirements : None

Returns the symbol image name
Created in NX7.5.0.



License requirements : None

Returns the Item Name, valid in team center
Created in NX7.5.0.



License requirements : None

Returns the item number, valid in team center
Created in NX7.5.0.



License requirements : None

Returns the note list
Created in NX7.5.0.



License requirements : None

Returns the part file name
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::MasterSymbolBuilder::Rename ( NXOpen::Annotations::MasterSymbol currentSymbolTag,
const NXString newSymbolName 
)

Renames symbol
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
currentSymbolTagsymbol Tag
newSymbolNameNew symbol name

Returns the revision, valid in team center
Created in NX7.5.0.



License requirements : None

Sets the anchor point
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
anchorPointanchorpoint

Sets the symbol image name
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
imageNameimagename

Sets if it is part symbol
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
isPartSymbolTrue If it is part symbol

Sets the Item Name, valid in team center
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
itemNameitemname

Sets the item number, valid in team center
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
itemNumberitemnumber

Setting Leader attachment point on builder side
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
attachmentTypeAttachment type either of left or right
leaderAttachmentPointAttachment point

Sets the part file name
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
partFileNamepartfilename

Setting Path retrieved from Global method at builder side
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
pathlocation of symbol

Sets the revision, valid in team center
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
revisionrevision

Sets the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
symbolNamesymbolname

Returns the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.