GeneralAnnotationSettingsBuilder Class

class NXOpen.AME.GeneralAnnotationSettingsBuilder

Bases: NXOpen.Builder

builder for the general annotation settings dialog

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

New in version NX11.0.0.

Properties

Property Description
AnnotationSetSeparator Returns or sets the separator for annotation set
Offset Returns or sets the text offset
SourceTargetSeparator Returns or sets the separator between source and target
Tag Returns the Tag for this object.
TextCFW Returns the text color font width
TextHeight Returns or sets the text height
TextPositionHorizontal Returns or sets the horizontal text position
TextPositionVertical Returns or sets the vertical text position

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.
ResetToDefault Set the default values
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

AnnotationSetSeparator

GeneralAnnotationSettingsBuilder.AnnotationSetSeparator

Returns or sets the separator for annotation set

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

Getter Method

Signature AnnotationSetSeparator

Returns:
Return type:NXOpen.AME.GeneralAnnotationSettingsBuilderAnnotationSeparator

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature AnnotationSetSeparator

Parameters:type (NXOpen.AME.GeneralAnnotationSettingsBuilderAnnotationSeparator) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Offset

GeneralAnnotationSettingsBuilder.Offset

Returns or sets the text offset

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

Getter Method

Signature Offset

Returns:
Return type:float

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Offset

Parameters:textOffset (float) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SourceTargetSeparator

GeneralAnnotationSettingsBuilder.SourceTargetSeparator

Returns or sets the separator between source and target

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

Getter Method

Signature SourceTargetSeparator

Returns:
Return type:NXOpen.AME.GeneralAnnotationSettingsBuilderSourceAndTargetSeparator

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SourceTargetSeparator

Parameters:type (NXOpen.AME.GeneralAnnotationSettingsBuilderSourceAndTargetSeparator) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

TextCFW

GeneralAnnotationSettingsBuilder.TextCFW

Returns the text color font width

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

Getter Method

Signature TextCFW

Returns:
Return type:NXOpen.TextColorFontWidthBuilder

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

TextHeight

GeneralAnnotationSettingsBuilder.TextHeight

Returns or sets the text height

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

Getter Method

Signature TextHeight

Returns:
Return type:float

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature TextHeight

Parameters:textHeight (float) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

TextPositionHorizontal

GeneralAnnotationSettingsBuilder.TextPositionHorizontal

Returns or sets the horizontal text position

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

Getter Method

Signature TextPositionHorizontal

Returns:
Return type:NXOpen.AME.GeneralAnnotationSettingsBuilderHorizontalTextPosition

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature TextPositionHorizontal

Parameters:type (NXOpen.AME.GeneralAnnotationSettingsBuilderHorizontalTextPosition) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

TextPositionVertical

GeneralAnnotationSettingsBuilder.TextPositionVertical

Returns or sets the vertical text position

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

Getter Method

Signature TextPositionVertical

Returns:
Return type:NXOpen.AME.GeneralAnnotationSettingsBuilderVerticalTextPosition

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature TextPositionVertical

Parameters:type (NXOpen.AME.GeneralAnnotationSettingsBuilderVerticalTextPosition) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

ResetToDefault

GeneralAnnotationSettingsBuilder.ResetToDefault

Set the default values

Signature ResetToDefault()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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