CannedAnnotationBuilder Class

class NXOpen.Diagramming.CannedAnnotationBuilder

Bases: NXOpen.Builder

Represents a CannedAnnotationBuilder.

To create a new instance of this class, use NXOpen.Diagramming.DiagrammingManager.CreateCannedAnnotationBuilder()

New in version NX10.0.0.

Properties

Property Description
AnnotationBuilder Returns the annotation of this canned annotation.
LeaderLines Returns the list of the leader lines.
Tag Returns the Tag for this object.
TextBoxIndent Returns or sets the indent value of the text box in the canned annotation.
TextBoxModifiable Returns or sets the flag that indicates if the text box in the canned annotation is modifiable.
TextBoxShadowBox Returns or sets the flag that indicates if the text box in the canned annotation has shadow box.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CreateLeaderLine Create a new NXOpen.Diagramming.LeaderLineBuilder 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.
Inherit Inherit.
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.

Enumerations

CannedAnnotationBuilderInheritOption Enumeration Represents the inherit option.

Property Detail

AnnotationBuilder

CannedAnnotationBuilder.AnnotationBuilder

Returns the annotation of this canned annotation.

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

Getter Method

Signature AnnotationBuilder

Returns:
Return type:NXOpen.Diagramming.AnnotationBuilder

New in version NX10.0.0.

License requirements: None.

LeaderLines

CannedAnnotationBuilder.LeaderLines

Returns the list of the leader lines.

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

Getter Method

Signature LeaderLines

Returns:
Return type:NXOpen.Diagramming.LeaderLineBuilderList

New in version NX10.0.0.

License requirements: None.

TextBoxIndent

CannedAnnotationBuilder.TextBoxIndent

Returns or sets the indent value of the text box in the canned annotation.

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

Getter Method

Signature TextBoxIndent

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TextBoxIndent

Parameters:indent (int) –

New in version NX10.0.0.

License requirements: None.

TextBoxModifiable

CannedAnnotationBuilder.TextBoxModifiable

Returns or sets the flag that indicates if the text box in the canned annotation is modifiable.

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

Getter Method

Signature TextBoxModifiable

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TextBoxModifiable

Parameters:isModifiable (bool) –

New in version NX10.0.0.

License requirements: None.

TextBoxShadowBox

CannedAnnotationBuilder.TextBoxShadowBox

Returns or sets the flag that indicates if the text box in the canned annotation has shadow box.

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

Getter Method

Signature TextBoxShadowBox

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TextBoxShadowBox

Parameters:isShadowBox (bool) –

New in version NX10.0.0.

License requirements: None.

Method Detail

CreateLeaderLine

CannedAnnotationBuilder.CreateLeaderLine

Create a new NXOpen.Diagramming.LeaderLineBuilder builder.

Signature CreateLeaderLine()

Returns:
Return type:NXOpen.Diagramming.LeaderLineBuilder

New in version NX10.0.0.

License requirements: None.

Inherit

CannedAnnotationBuilder.Inherit

Inherit.

Signature Inherit(inheritOption, annotation)

Parameters:

New in version NX11.0.0.

License requirements: None.

Validate

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