NXOpen::AME::SymbolNoteBuilder Class Reference

Represents a Symbol Note creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolNoteBuilder
Default values. More...

Inheritance diagram for NXOpen::AME::SymbolNoteBuilder:

Public Member Functions
void	AddAttribute (const NXString &propertyName, NXOpen::NXObject *propertyReference)
	Add the attribute Created in NX1847.0.0. More...
void	AddAttribute (const char *propertyName, NXOpen::NXObject *propertyReference)
	Add the attribute Created in NX1847.0.0. More...
void	AddNewAttribute (NXOpen::NXObject *attrOwner, const NXString &attrTitle, NXOpen::AME::AmeSymbolAnnotationAttributesource attrCategory)
	Add the new attribute Created in NX1847.0.0. More...
void	AddNewAttribute (NXOpen::NXObject *attrOwner, const char *attrTitle, NXOpen::AME::AmeSymbolAnnotationAttributesource attrCategory)
	Add the new attribute Created in NX1847.0.0. More...
NXOpen::AME::AmeSymbolAnnotationContactblock	ContactBlock ()
	Returns the contact block annotation type Created in NX1847.0.0. More...
void	MoveDownAttribute (int attrIndex)
	Move down attribute Created in NX1847.0.0. More...
void	MoveUpAttribute (int attrIndex)
	Move up attribute Created in NX1847.0.0. More...
NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin Created in NX1847.0.0. More...
void	RemoveAttribute (int attrIndex)
	Remove the attribute Created in NX1847.0.0. More...
void	ResetPropertyList ()
	Reset the property list Created in NX1847.0.0. More...
void	ResetToDefault ()
	Resets the symbol annotation settings to default. More...
void	SetContactBlock (NXOpen::AME::AmeSymbolAnnotationContactblock type)
	Sets the contact block annotation type Created in NX1847.0.0. More...
void	SetType (NXOpen::AME::AmeSymbolAnnotationType type)
	Sets the Annotation type Created in NX1847.0.0. More...
NXOpen::AME::SymbolAnnotationStyleBuilder *	SymbolAnnotationStyle ()
	Returns the symbolAnnotationStyle Created in NX1847.0.0. More...
NXOpen::AME::AmeSymbolAnnotationType	Type ()
	Returns the Annotation type Created in NX1847.0.0. More...
void	UpdateAttributeCategory (int attrIndex, NXOpen::AME::AmeSymbolAnnotationAttributesource attrCategory)
	Update attribute category Created in NX1847.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a Symbol Note creation class Builder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateSymbolNoteBuilder
Default values.

Property	Value
SymbolAnnotationStyle.Anchor	BottomRight
SymbolAnnotationStyle.Height	Two
SymbolAnnotationStyle.Justification	Right
SymbolAnnotationStyle.LetteringAngle	Degree0

Created in NX1847.0.0.

Member Function Documentation

void NXOpen::AME::SymbolNoteBuilder::AddAttribute	(	const NXString &	propertyName,
		NXOpen::NXObject *	propertyReference
	)

Add the attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

propertyName	propertyname
propertyReference	propertyreference

void NXOpen::AME::SymbolNoteBuilder::AddAttribute	(	const char *	propertyName,
		NXOpen::NXObject *	propertyReference
	)

Add the attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

propertyName	propertyname
propertyReference	propertyreference

void NXOpen::AME::SymbolNoteBuilder::AddNewAttribute	(	NXOpen::NXObject *	attrOwner,
		const NXString &	attrTitle,
		NXOpen::AME::AmeSymbolAnnotationAttributesource	attrCategory
	)

Add the new attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrOwner	attrowner
attrTitle	attrtitle
attrCategory	attrcategory

void NXOpen::AME::SymbolNoteBuilder::AddNewAttribute	(	NXOpen::NXObject *	attrOwner,
		const char *	attrTitle,
		NXOpen::AME::AmeSymbolAnnotationAttributesource	attrCategory
	)

Add the new attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrOwner	attrowner
attrTitle	attrtitle
attrCategory	attrcategory

NXOpen::AME::AmeSymbolAnnotationContactblock NXOpen::AME::SymbolNoteBuilder::ContactBlock

(

)

Returns the contact block annotation type
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolNoteBuilder::MoveDownAttribute

(

int

attrIndex

)

Move down attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrIndex

attrindex

void NXOpen::AME::SymbolNoteBuilder::MoveUpAttribute

(

int

attrIndex

)

Move up attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrIndex

attrindex

NXOpen::Annotations::OriginBuilder* NXOpen::AME::SymbolNoteBuilder::Origin

(

)

Returns the origin
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolNoteBuilder::RemoveAttribute

(

int

attrIndex

)

Remove the attribute
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrIndex

attrindex

void NXOpen::AME::SymbolNoteBuilder::ResetPropertyList

(

)

Reset the property list
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolNoteBuilder::ResetToDefault

(

)

Resets the symbol annotation settings to default.

Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolNoteBuilder::SetContactBlock

(

NXOpen::AME::AmeSymbolAnnotationContactblock

type

)

Sets the contact block annotation type
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type

type

void NXOpen::AME::SymbolNoteBuilder::SetType

(

NXOpen::AME::AmeSymbolAnnotationType

type

)

Sets the Annotation type
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

type

type

NXOpen::AME::SymbolAnnotationStyleBuilder* NXOpen::AME::SymbolNoteBuilder::SymbolAnnotationStyle

(

)

Returns the symbolAnnotationStyle
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXOpen::AME::AmeSymbolAnnotationType NXOpen::AME::SymbolNoteBuilder::Type

(

)

Returns the Annotation type
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::SymbolNoteBuilder::UpdateAttributeCategory	(	int	attrIndex,
		NXOpen::AME::AmeSymbolAnnotationAttributesource	attrCategory
	)

Update attribute category
Created in NX1847.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

attrIndex	attrindex
attrCategory	attrcategory

---

The documentation for this class was generated from the following file:

• AME_SymbolNoteBuilder.hxx