NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::BalloonNoteBuilder Class Reference

Represents a NXOpen::Annotations::BalloonNote builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateBalloonNoteBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::BalloonNoteBuilder:
NXOpen::Annotations::PmiAttributeBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString BalloonText ()
 Returns the balloon text
Created in NX6.0.0. More...
 
NXString Category ()
 Returns the category
Created in NX6.0.0. More...
 
std::vector< NXStringGetText ()
 Returns the text. More...
 
NXString Identifier ()
 Returns the identifier
Created in NX6.0.0. More...
 
NXString Revision ()
 Returns the revision
Created in NX6.0.0. More...
 
double Scale ()
 Returns the scale
Created in NX6.0.0. More...
 
void SetBalloonText (const NXString &balloonText)
 Sets the balloon text
Created in NX6.0.0. More...
 
void SetBalloonText (const char *balloonText)
 Sets the balloon text
Created in NX6.0.0. More...
 
void SetCategory (const NXString &category)
 Sets the category
Created in NX6.0.0. More...
 
void SetCategory (const char *category)
 Sets the category
Created in NX6.0.0. More...
 
void SetIdentifier (const NXString &identifier)
 Sets the identifier
Created in NX6.0.0. More...
 
void SetIdentifier (const char *identifier)
 Sets the identifier
Created in NX6.0.0. More...
 
void SetRevision (const NXString &revision)
 Sets the revision
Created in NX6.0.0. More...
 
void SetRevision (const char *revision)
 Sets the revision
Created in NX6.0.0. More...
 
void SetScale (double scale)
 Sets the scale
Created in NX6.0.0. More...
 
void SetText (const std::vector< NXString > &text)
 Sets the text
Created in NX6.0.0. More...
 
void SetTitle (const NXString &title)
 Sets the title
Created in NX6.0.0. More...
 
void SetTitle (const char *title)
 Sets the title
Created in NX6.0.0. More...
 
NXString Title ()
 Returns the title
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Annotations::PmiAttributeBuilder
NXOpen::Annotations::AssociatedObjectsBuilderAssociatedObjects ()
 Returns the NXOpen::Annotations::AssociatedObjectsBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::PmiAttribute ()
 Returns the NXOpen::Annotations::Pmi for this annotation
Created in NX6.0.0. More...
 
NXOpen::NXObjectBusinessModifier ()
 Returns the business modifier
Created in NX6.0.0. More...
 
std::vector< NXOpen::NXObject * > GetAttributeValues ()
 Returns the attribute values. More...
 
NXString KnowledgeFusionClassName ()
 Returns the knowledge fusion class name file, the default class is UG provided pmi KF class
Created in NX6.0.0. More...
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the NXOpen::Annotations::OriginBuilder for the annotation
Created in NX6.0.0. More...
 
void SetAttribute (NXOpen::Annotations::Pmi *attribute)
 Sets the NXOpen::Annotations::Pmi for this annotation
Created in NX6.0.0. More...
 
void SetAttributeValues (const std::vector< NXOpen::NXObject * > &attributeValues)
 Sets the attribute values
Created in NX6.0.0. More...
 
void SetBusinessModifier (NXOpen::NXObject *businessModifier)
 Sets the business modifier
Created in NX6.0.0. More...
 
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. More...
 
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. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the NXOpen::Annotations::StyleBuilder for the annotation
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 NXOpen::Annotations::BalloonNote builder
To create a new instance of this class, use NXOpen::Annotations::PmiAttributeCollection::CreateBalloonNoteBuilder

Created in NX6.0.0.


Member Function Documentation

NXString NXOpen::Annotations::BalloonNoteBuilder::BalloonText ( )

Returns the balloon text
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::BalloonNoteBuilder::Category ( )

Returns the category
Created in NX6.0.0.



License requirements : None

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

Returns the text.

Returns

Created in NX6.0.0.

License requirements : None
NXString NXOpen::Annotations::BalloonNoteBuilder::Identifier ( )

Returns the identifier
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::BalloonNoteBuilder::Revision ( )

Returns the revision
Created in NX6.0.0.



License requirements : None

double NXOpen::Annotations::BalloonNoteBuilder::Scale ( )

Returns the scale
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::BalloonNoteBuilder::SetBalloonText ( const NXString balloonText)

Sets the balloon text
Created in NX6.0.0.



License requirements : None

Parameters
balloonTextballoontext
void NXOpen::Annotations::BalloonNoteBuilder::SetBalloonText ( const char *  balloonText)

Sets the balloon text
Created in NX6.0.0.



License requirements : None

Parameters
balloonTextballoontext
void NXOpen::Annotations::BalloonNoteBuilder::SetCategory ( const NXString category)

Sets the category
Created in NX6.0.0.



License requirements : None

Parameters
categorycategory
void NXOpen::Annotations::BalloonNoteBuilder::SetCategory ( const char *  category)

Sets the category
Created in NX6.0.0.



License requirements : None

Parameters
categorycategory
void NXOpen::Annotations::BalloonNoteBuilder::SetIdentifier ( const NXString identifier)

Sets the identifier
Created in NX6.0.0.



License requirements : None

Parameters
identifieridentifier
void NXOpen::Annotations::BalloonNoteBuilder::SetIdentifier ( const char *  identifier)

Sets the identifier
Created in NX6.0.0.



License requirements : None

Parameters
identifieridentifier
void NXOpen::Annotations::BalloonNoteBuilder::SetRevision ( const NXString revision)

Sets the revision
Created in NX6.0.0.



License requirements : None

Parameters
revisionrevision
void NXOpen::Annotations::BalloonNoteBuilder::SetRevision ( const char *  revision)

Sets the revision
Created in NX6.0.0.



License requirements : None

Parameters
revisionrevision
void NXOpen::Annotations::BalloonNoteBuilder::SetScale ( double  scale)

Sets the scale
Created in NX6.0.0.



License requirements : None

Parameters
scalescale
void NXOpen::Annotations::BalloonNoteBuilder::SetText ( const std::vector< NXString > &  text)

Sets the text
Created in NX6.0.0.



License requirements : None

Parameters
texttext
void NXOpen::Annotations::BalloonNoteBuilder::SetTitle ( const NXString title)

Sets the title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
void NXOpen::Annotations::BalloonNoteBuilder::SetTitle ( const char *  title)

Sets the title
Created in NX6.0.0.



License requirements : None

Parameters
titletitle
NXString NXOpen::Annotations::BalloonNoteBuilder::Title ( )

Returns the title
Created in NX6.0.0.



License requirements : None


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