BalloonNoteBuilder Class

class NXOpen.Annotations.BalloonNoteBuilder

Bases: NXOpen.Annotations.PmiAttributeBuilder

Represents a NXOpen.Annotations.BalloonNote builder

To create a new instance of this class, use NXOpen.Annotations.PmiAttributeCollection.CreateBalloonNoteBuilder()

New in version NX6.0.0.

Properties

Property Description
AssociatedObjects Returns the NXOpen.Annotations.AssociatedObjectsBuilder for the annotation
Attribute Returns or sets the NXOpen.Annotations.Pmi for this annotation
BalloonText Returns or sets the balloon text
BusinessModifier Returns or sets the business modifier
Category Returns or sets the category
Identifier Returns or sets the identifier
KnowledgeFusionClassName Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class
Leader Returns the NXOpen.Annotations.LeaderBuilder for the annotation
Origin Returns the NXOpen.Annotations.OriginBuilder for the annotation
Revision Returns or sets the revision
Scale Returns or sets the scale
Style Returns the NXOpen.Annotations.StyleBuilder for the annotation
Tag Returns the Tag for this object.
Title Returns or sets the title

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetAttributeValues Returns the attribute values
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
GetText Returns the text
SetAttributeValues Sets the attribute values
SetText Sets the text
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BalloonText

BalloonNoteBuilder.BalloonText

Returns or sets the balloon text

-------------------------------------

Getter Method

Signature BalloonText

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BalloonText

Parameters:balloonText (str) –

New in version NX6.0.0.

License requirements: None.

Category

BalloonNoteBuilder.Category

Returns or sets the category

-------------------------------------

Getter Method

Signature Category

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Category

Parameters:category (str) –

New in version NX6.0.0.

License requirements: None.

Identifier

BalloonNoteBuilder.Identifier

Returns or sets the identifier

-------------------------------------

Getter Method

Signature Identifier

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Identifier

Parameters:identifier (str) –

New in version NX6.0.0.

License requirements: None.

Revision

BalloonNoteBuilder.Revision

Returns or sets the revision

-------------------------------------

Getter Method

Signature Revision

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Revision

Parameters:revision (str) –

New in version NX6.0.0.

License requirements: None.

Scale

BalloonNoteBuilder.Scale

Returns or sets the scale

-------------------------------------

Getter Method

Signature Scale

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Scale

Parameters:scale (float) –

New in version NX6.0.0.

License requirements: None.

Title

BalloonNoteBuilder.Title

Returns or sets the title

-------------------------------------

Getter Method

Signature Title

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Title

Parameters:title (str) –

New in version NX6.0.0.

License requirements: None.

Method Detail

GetText

BalloonNoteBuilder.GetText

Returns the text

Signature GetText()

Returns:
Return type:list of str

New in version NX6.0.0.

License requirements: None.

SetText

BalloonNoteBuilder.SetText

Sets the text

Signature SetText(text)

Parameters:text (list of str) –

New in version NX6.0.0.

License requirements: None.

Validate

BalloonNoteBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.