SymbolAnnotationBuilder Class

class NXOpen.AME.SymbolAnnotationBuilder

Bases: NXOpen.Builder

Represents a Symbol Annotation creation class Builder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateSymbolAnnotationBuilder()

New in version NX12.0.0.

Properties

Property Description
AnchorPointLocation Returns the symbol anchor point
SymbolAnnotationAnchor Returns or sets the anchor
SymbolAnnotationOrientation Returns or sets the orientation
SymbolAnnotationPoint Returns or sets the symbol annotation point
Tag Returns the Tag for this object.

Methods

Method Description
AddCheckedAttribute Add the checked attribute.
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.
ResetPropertyList Reset the property list.
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

SymbolAnnotationBuilderAnchor Enumeration Represents anchor of annotation
SymbolAnnotationBuilderOrientation Enumeration Represents orientation of annotation

Property Detail

AnchorPointLocation

SymbolAnnotationBuilder.AnchorPointLocation

Returns the symbol anchor point

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

Getter Method

Signature AnchorPointLocation

Returns:
Return type:NXOpen.Point2d

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationAnchor

SymbolAnnotationBuilder.SymbolAnnotationAnchor

Returns or sets the anchor

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

Getter Method

Signature SymbolAnnotationAnchor

Returns:
Return type:NXOpen.AME.SymbolAnnotationBuilderAnchor

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationAnchor

Parameters:anchor (NXOpen.AME.SymbolAnnotationBuilderAnchor) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationOrientation

SymbolAnnotationBuilder.SymbolAnnotationOrientation

Returns or sets the orientation

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

Getter Method

Signature SymbolAnnotationOrientation

Returns:
Return type:NXOpen.AME.SymbolAnnotationBuilderOrientation

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationOrientation

Parameters:orientation (NXOpen.AME.SymbolAnnotationBuilderOrientation) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationPoint

SymbolAnnotationBuilder.SymbolAnnotationPoint

Returns or sets the symbol annotation point

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

Getter Method

Signature SymbolAnnotationPoint

Returns:
Return type:NXOpen.Point2d

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationPoint

Parameters:symbolAnnotationPoint (NXOpen.Point2d) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

AddCheckedAttribute

SymbolAnnotationBuilder.AddCheckedAttribute

Add the checked attribute.

Signature AddCheckedAttribute(propertyName, propertyReference)

Parameters:

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ResetPropertyList

SymbolAnnotationBuilder.ResetPropertyList

Reset the property list.

Signature ResetPropertyList()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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