NX Open C++ Reference Guide
|
Represents a Builder for MasterSymbol functionality
To create a new instance of this class, use Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder
Default values.
More...
Public Types | |
enum | LeaderAttachmentType { LeaderAttachmentTypeLeft, LeaderAttachmentTypeRight } |
The Enum for Attachment options. More... | |
Public Member Functions | |
NXOpen::Point * | AnchorPoint () |
Returns the anchor point Created in NX7.5.0. | |
NXOpen::SelectNXObjectList * | Contents () |
Returns the select object Created in NX7.5.0. | |
NXOpen::Annotations::MasterSymbolListItemBuilder * | CreateNewListItem (NXOpen::Annotations::Annotation *noteTag, const std::vector< NXString > ¬es) |
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::Point * | GetLeaderAttachmentPoint (NXOpen::Annotations::MasterSymbolBuilder::LeaderAttachmentType attachmentType) |
Getting Leader attachment point from builder side. | |
std::vector< NXString > | GetMultilineString () |
Returns the multiple notes for a given Text Type. | |
NXOpen::Gateway::ImageCaptureBuilder * | ImageCapture () |
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::NXObjectList * | NoteList () |
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. |
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.
Returns the anchor point
Created in NX7.5.0.
License requirements : None
Returns the select object
Created in NX7.5.0.
License requirements : None
NXOpen::Annotations::MasterSymbolListItemBuilder* NXOpen::Annotations::MasterSymbolBuilder::CreateNewListItem | ( | NXOpen::Annotations::Annotation * | noteTag, |
const std::vector< NXString > & | notes | ||
) |
Create Master Symbol list item builder.
noteTag | notetag |
notes | name of the solution |
void NXOpen::Annotations::MasterSymbolBuilder::EditImage | ( | NXOpen::Annotations::MasterSymbol * | currentSymbolTag, |
const NXString & | newImageName | ||
) |
Changes symbol image
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
currentSymbolTag | symbol Tag |
newImageName | New 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")
NXOpen::Point* NXOpen::Annotations::MasterSymbolBuilder::GetLeaderAttachmentPoint | ( | NXOpen::Annotations::MasterSymbolBuilder::LeaderAttachmentType | attachmentType | ) |
Getting Leader attachment point from builder side.
attachmentType | Attachment type either of left or right |
std::vector<NXString> NXOpen::Annotations::MasterSymbolBuilder::GetMultilineString | ( | ) |
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 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")
currentSymbolTag | symbol Tag |
newSymbolName | New symbol name |
Returns the revision, valid in team center
Created in NX7.5.0.
License requirements : None
void NXOpen::Annotations::MasterSymbolBuilder::SetAnchorPoint | ( | NXOpen::Point * | anchorPoint | ) |
Sets the anchor point
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
anchorPoint | anchorpoint |
void NXOpen::Annotations::MasterSymbolBuilder::SetImageName | ( | const NXString & | imageName | ) |
Sets the symbol image name
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
imageName | imagename |
void NXOpen::Annotations::MasterSymbolBuilder::SetIsPartSymbol | ( | bool | isPartSymbol | ) |
Sets if it is part symbol
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
isPartSymbol | True If it is part symbol |
void NXOpen::Annotations::MasterSymbolBuilder::SetItemName | ( | const NXString & | itemName | ) |
Sets the Item Name, valid in team center
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
itemName | itemname |
void NXOpen::Annotations::MasterSymbolBuilder::SetItemNumber | ( | const NXString & | itemNumber | ) |
Sets the item number, valid in team center
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
itemNumber | itemnumber |
void NXOpen::Annotations::MasterSymbolBuilder::SetLeaderAttachmentPoint | ( | NXOpen::Annotations::MasterSymbolBuilder::LeaderAttachmentType | attachmentType, |
NXOpen::Point * | leaderAttachmentPoint | ||
) |
Setting Leader attachment point on builder side
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
attachmentType | Attachment type either of left or right |
leaderAttachmentPoint | Attachment point |
void NXOpen::Annotations::MasterSymbolBuilder::SetPartFileName | ( | const NXString & | partFileName | ) |
Sets the part file name
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
partFileName | partfilename |
void NXOpen::Annotations::MasterSymbolBuilder::SetPath | ( | const NXString & | path | ) |
Setting Path retrieved from Global method at builder side
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
path | location of symbol |
void NXOpen::Annotations::MasterSymbolBuilder::SetRevision | ( | const NXString & | revision | ) |
Sets the revision, valid in team center
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
revision | revision |
void NXOpen::Annotations::MasterSymbolBuilder::SetSymbolName | ( | const NXString & | symbolName | ) |
Sets the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
symbolName | symbolname |
Returns the JA method support for accessing and setting Symbol Name value
Created in NX7.5.0.
License requirements : None