Represents a Builder for MasterSymbol functionality <br> To create a new instance of this class, use @link Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder  Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Annotations::MasterSymbolBuilder:

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 > &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	EditImage (NXOpen::Annotations::MasterSymbol currentSymbolTag, const char 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.

void	Rename (NXOpen::Annotations::MasterSymbol currentSymbolTag, const char 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	SetImageName (const char *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	SetItemName (const char *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	SetItemNumber (const char *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	SetPartFileName (const char *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	SetPath (const char *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	SetRevision (const char *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.

void	SetSymbolName (const char *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.

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

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Builder for MasterSymbol functionality <br> To create a new instance of this class, use @link Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder  Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder @endlink  <br>

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:

LeaderAttachmentTypeLeft	Left Attachment.
LeaderAttachmentTypeRight	Right Attachment.

Member Function Documentation

NXOpen::Point* NXOpen::Annotations::MasterSymbolBuilder::AnchorPoint ( )

Returns the anchor point
Created in NX7.5.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Annotations::MasterSymbolBuilder::Contents ( )

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.

Returns: Created in NX7.5.0.

License requirements : None

Parameters

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")

Parameters

currentSymbolTag	symbol Tag
newImageName	New image name

void NXOpen::Annotations::MasterSymbolBuilder::EditImage	(	NXOpen::Annotations::MasterSymbol *	currentSymbolTag,
		const char *	newImageName
	)

Changes symbol image
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

currentSymbolTag	symbol Tag
newImageName	New image name

void NXOpen::Annotations::MasterSymbolBuilder::GenerateItemNumber ( )

Item number assign button.

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

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::MasterSymbolBuilder::GenerateRevision ( )

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.

Returns: Created in NX7.5.0.

License requirements : None

Parameters

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 
       @link Annotations::MasterSymbolListItemBuilder::TextType Annotations::MasterSymbolListItemBuilder::TextType@endlink  is either of controlled, partially controlled or arbitory  @return  Multiple notes as Output

Created in NX7.5.0.

License requirements : None

NXOpen::Gateway::ImageCaptureBuilder* NXOpen::Annotations::MasterSymbolBuilder::ImageCapture ( )

Returns the image capture builder
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolBuilder::ImageName ( )

Returns the symbol image name
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolBuilder::ItemName ( )

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

License requirements : None

NXString NXOpen::Annotations::MasterSymbolBuilder::ItemNumber ( )

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

License requirements : None

NXOpen::NXObjectList* NXOpen::Annotations::MasterSymbolBuilder::NoteList ( )

Returns the note list
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::MasterSymbolBuilder::PartFileName ( )

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

currentSymbolTag	symbol Tag
newSymbolName	New symbol name

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

Renames symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

currentSymbolTag	symbol Tag
newSymbolName	New symbol name

NXString NXOpen::Annotations::MasterSymbolBuilder::Revision ( )

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")

Parameters

anchorPoint anchorpoint

void NXOpen::Annotations::MasterSymbolBuilder::SetImageName ( const NXString & imageName )

Sets the symbol image name
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

imageName imagename

void NXOpen::Annotations::MasterSymbolBuilder::SetImageName ( const char * imageName )

Sets the symbol image name
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

imageName imagename

void NXOpen::Annotations::MasterSymbolBuilder::SetIsPartSymbol ( bool isPartSymbol )

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

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

itemName itemname

void NXOpen::Annotations::MasterSymbolBuilder::SetItemName ( const char * itemName )

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

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

itemNumber itemnumber

void NXOpen::Annotations::MasterSymbolBuilder::SetItemNumber ( const char * itemNumber )

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

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

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")

Parameters

partFileName partfilename

void NXOpen::Annotations::MasterSymbolBuilder::SetPartFileName ( const char * partFileName )

Sets the part file name
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

path	location of symbol

void NXOpen::Annotations::MasterSymbolBuilder::SetPath ( const char * path )

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

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

revision revision

void NXOpen::Annotations::MasterSymbolBuilder::SetRevision ( const char * revision )

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

License requirements : drafting ("DRAFTING")

Parameters

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")

Parameters

symbolName symbolname

void NXOpen::Annotations::MasterSymbolBuilder::SetSymbolName ( const char * symbolName )

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

License requirements : drafting ("DRAFTING")

Parameters

symbolName symbolname

NXString NXOpen::Annotations::MasterSymbolBuilder::SymbolName ( )

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:

Annotations_MasterSymbolBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation