Represents a Annotations::GeneralNote builder
To create a new instance of this class, use Annotations::PmiAttributeCollection::CreateGeneralNoteBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::GeneralNoteBuilder:

Public Member Functions
NXString	Category ()
	Returns the category Created in NX6.0.0.

std::vector< NXString >	GetText ()
	Returns the text.

NXString	Identifier ()
	Returns the identifier Created in NX6.0.0.

NXString	Revision ()
	Returns the revision Created in NX6.0.0.

void	SetCategory (const NXString &category)
	Sets the category Created in NX6.0.0.

void	SetCategory (const char *category)
	Sets the category Created in NX6.0.0.

void	SetIdentifier (const NXString &identifier)
	Sets the identifier Created in NX6.0.0.

void	SetIdentifier (const char *identifier)
	Sets the identifier Created in NX6.0.0.

void	SetRevision (const NXString &revision)
	Sets the revision Created in NX6.0.0.

void	SetRevision (const char *revision)
	Sets the revision Created in NX6.0.0.

void	SetText (const std::vector< NXString > &text)
	Sets the text Created in NX6.0.0.

void	SetTitle (const NXString &title)
	Sets the str title Created in NX6.0.0.

void	SetTitle (const char *title)
	Sets the str title Created in NX6.0.0.

NXString	Title ()
	Returns the str title Created in NX6.0.0.

Public Member Functions inherited from NXOpen::Annotations::PmiAttributeBuilder
NXOpen::Annotations::AssociatedObjectsBuilder *	AssociatedObjects ()
	Returns the Annotations::AssociatedObjectsBuilder for the annotation Created in NX6.0.0.

NXOpen::Annotations::Pmi *	Attribute ()
	Returns the Annotations::Pmi for this annotation Created in NX6.0.0.

NXOpen::NXObject *	BusinessModifier ()
	Returns the business modifier Created in NX6.0.0.

std::vector< NXOpen::NXObject * >	GetAttributeValues ()
	Returns the attribute values.

NXString	KnowledgeFusionClassName ()
	Returns the knowledge fusion class name file, the default class is UG provided pmi KF class Created in NX6.0.0.

NXOpen::Annotations::LeaderBuilder *	Leader ()
	Returns the Annotations::LeaderBuilder for the annotation Created in NX6.0.0.

NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the Annotations::OriginBuilder for the annotation Created in NX6.0.0.

void	SetAttribute (NXOpen::Annotations::Pmi *attribute)
	Sets the Annotations::Pmi for this annotation Created in NX6.0.0.

void	SetAttributeValues (const std::vector< NXOpen::NXObject * > &attributeValues)
	Sets the attribute values Created in NX6.0.0.

void	SetBusinessModifier (NXOpen::NXObject *businessModifier)
	Sets the business modifier Created in NX6.0.0.

void	SetKnowledgeFusionClassName (const NXString &knowledgeFusionClassName)
	Sets the knowledge fusion class name file, the default class is UG provided pmi KF class Created in NX6.0.0.

void	SetKnowledgeFusionClassName (const char *knowledgeFusionClassName)
	Sets the knowledge fusion class name file, the default class is UG provided pmi KF class Created in NX6.0.0.

NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the Annotations::StyleBuilder for the annotation Created in NX6.0.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 Annotations::GeneralNote builder
To create a new instance of this class, use Annotations::PmiAttributeCollection::CreateGeneralNoteBuilder

Created in NX6.0.0.

Member Function Documentation

NXString NXOpen::Annotations::GeneralNoteBuilder::Category ( )

Returns the category
Created in NX6.0.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::GeneralNoteBuilder::GetText ( )

Returns the text.

Returns: Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::GeneralNoteBuilder::Identifier ( )

Returns the identifier
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::GeneralNoteBuilder::Revision ( )

Returns the revision
Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::GeneralNoteBuilder::SetCategory ( const NXString & category )

Sets the category
Created in NX6.0.0.

License requirements : None

Parameters

category category

void NXOpen::Annotations::GeneralNoteBuilder::SetCategory ( const char * category )

Sets the category
Created in NX6.0.0.

License requirements : None

Parameters

category category

void NXOpen::Annotations::GeneralNoteBuilder::SetIdentifier ( const NXString & identifier )

Sets the identifier
Created in NX6.0.0.

License requirements : None

Parameters

identifier identifier

void NXOpen::Annotations::GeneralNoteBuilder::SetIdentifier ( const char * identifier )

Sets the identifier
Created in NX6.0.0.

License requirements : None

Parameters

identifier identifier

void NXOpen::Annotations::GeneralNoteBuilder::SetRevision ( const NXString & revision )

Sets the revision
Created in NX6.0.0.

License requirements : None

Parameters

revision revision

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

Sets the revision
Created in NX6.0.0.

License requirements : None

Parameters

revision revision

void NXOpen::Annotations::GeneralNoteBuilder::SetText ( const std::vector< NXString > & text )

Sets the text
Created in NX6.0.0.

License requirements : None

Parameters

text text

void NXOpen::Annotations::GeneralNoteBuilder::SetTitle ( const NXString & title )

Sets the str title
Created in NX6.0.0.

License requirements : None

Parameters

title title

void NXOpen::Annotations::GeneralNoteBuilder::SetTitle ( const char * title )

Sets the str title
Created in NX6.0.0.

License requirements : None

Parameters

title title

NXString NXOpen::Annotations::GeneralNoteBuilder::Title ( )

Returns the str title
Created in NX6.0.0.

License requirements : None

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

Annotations_GeneralNoteBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation