SymbolAnnotationSettingsBuilder Class

class NXOpen.AME.SymbolAnnotationSettingsBuilder

Bases: NXOpen.Builder

JA class for the symbol settings

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

New in version NX12.0.0.

Properties

Property Description
PortAnnotationHeight Returns or sets the port annotation text height
PortAnnotationTextCFW Returns or sets the port annotation text color font width
PortAnnotationTextOverlined Returns or sets whether the symbol annotation text is overlined
PortAnnotationTextUnderlined Returns or sets whether the symbol annotation text is underlined
SymbolAnnotationHeight Returns or sets the symbol annotation text height
SymbolAnnotationTextAlignment Returns or sets the symbol annotation text alignment
SymbolAnnotationTextCFW Returns or sets the symbol annotation text color font width
SymbolAnnotationTextOverlined Returns or sets whether the symbol annotation text is overlined
SymbolAnnotationTextUnderlined Returns or sets whether the symbol annotation text is underlined
Tag Returns the Tag for this object.

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 Reset to default setting
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

PortAnnotationHeight

SymbolAnnotationSettingsBuilder.PortAnnotationHeight

Returns or sets the port annotation text height

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

Getter Method

Signature PortAnnotationHeight

Returns:
Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PortAnnotationHeight

Parameters:textHeight (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

PortAnnotationTextCFW

SymbolAnnotationSettingsBuilder.PortAnnotationTextCFW

Returns or sets the port annotation text color font width

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

Getter Method

Signature PortAnnotationTextCFW

Returns:
Return type:NXOpen.TextColorFontWidthBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PortAnnotationTextCFW

Parameters:textColorFontWidth (NXOpen.TextColorFontWidthBuilder) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

PortAnnotationTextOverlined

SymbolAnnotationSettingsBuilder.PortAnnotationTextOverlined

Returns or sets whether the symbol annotation text is overlined

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

Getter Method

Signature PortAnnotationTextOverlined

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PortAnnotationTextOverlined

Parameters:overlined (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

PortAnnotationTextUnderlined

SymbolAnnotationSettingsBuilder.PortAnnotationTextUnderlined

Returns or sets whether the symbol annotation text is underlined

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

Getter Method

Signature PortAnnotationTextUnderlined

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature PortAnnotationTextUnderlined

Parameters:underlined (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationHeight

SymbolAnnotationSettingsBuilder.SymbolAnnotationHeight

Returns or sets the symbol annotation text height

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

Getter Method

Signature SymbolAnnotationHeight

Returns:
Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationHeight

Parameters:textHeight (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationTextAlignment

SymbolAnnotationSettingsBuilder.SymbolAnnotationTextAlignment

Returns or sets the symbol annotation text alignment

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

Getter Method

Signature SymbolAnnotationTextAlignment

Returns:
Return type:int

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationTextAlignment

Parameters:alignment (int) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationTextCFW

SymbolAnnotationSettingsBuilder.SymbolAnnotationTextCFW

Returns or sets the symbol annotation text color font width

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

Getter Method

Signature SymbolAnnotationTextCFW

Returns:
Return type:NXOpen.TextColorFontWidthBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationTextCFW

Parameters:textColorFontWidth (NXOpen.TextColorFontWidthBuilder) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationTextOverlined

SymbolAnnotationSettingsBuilder.SymbolAnnotationTextOverlined

Returns or sets whether the symbol annotation text is overlined

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

Getter Method

Signature SymbolAnnotationTextOverlined

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationTextOverlined

Parameters:overlined (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SymbolAnnotationTextUnderlined

SymbolAnnotationSettingsBuilder.SymbolAnnotationTextUnderlined

Returns or sets whether the symbol annotation text is underlined

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

Getter Method

Signature SymbolAnnotationTextUnderlined

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SymbolAnnotationTextUnderlined

Parameters:underlined (bool) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

ResetToDefault

SymbolAnnotationSettingsBuilder.ResetToDefault

Reset to default setting

Signature ResetToDefault()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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