PmiNoteBuilder Class¶

class NXOpen.Annotations.PmiNoteBuilder¶

Bases: NXOpen.Annotations.DraftingNoteBuilder

Represents a NXOpen.Annotations.Note builder

To create a new instance of this class, use NXOpen.Annotations.AnnotationManager.CreatePmiNoteBuilder()

New in version NX6.0.0.

Properties¶

Property	Description
AssociatedObjects	Returns the `NXOpen.Annotations.AssociatedObjectsBuilder` for note
ForeshorteningSymbol	Returns the foreshortening symbol builder
Inherit	Returns the note from which the properties are inherited
Leader	Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation
Origin	Returns the origin
Style	Returns the style builder
Tag	Returns the Tag for this object.
Text	Returns the text
TextAlignment	Returns or sets the text alignment
VerticalText	Returns or sets the vertical text for text

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.
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.
InheritProperties	Inheriting properties from the note
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¶

AssociatedObjects¶

PmiNoteBuilder.AssociatedObjects¶

Returns the NXOpen.Annotations.AssociatedObjectsBuilder for note

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

Getter Method

Signature AssociatedObjects

Returns:
Return type:	`NXOpen.Annotations.AssociatedObjectsBuilder`

New in version NX6.0.0.

License requirements: None.

Method Detail¶

Validate¶

PmiNoteBuilder.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.