AppendedTextBuilder Class

class NXOpen.Annotations.AppendedTextBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

This class is used to set/access the appended text of a dimension

This is a sub-builder class and cannot be directly instantiated

New in version NX9.0.0.

Properties

Property Description
Tag Returns the Tag for this object.
UserDefinedSymbolAspectRatio Returns or sets the aspect ratio for user defined symbol
UserDefinedSymbolHeight Returns or sets the height for user defined symbol
UserDefinedSymbolLength Returns or sets the length for user defined symbol
UserDefinedSymbolScale Returns or sets the scale for user defined symbol

Methods

Method Description
GetAbove Gets the appended text above the annotation
GetAfter Gets the appended text after the annotation
GetBefore Gets the appended text before the annotation
GetBelow Gets the appended text below the annotation
SetAbove Sets the appended text above the annotation
SetAfter Sets the appended text after the annotation
SetBefore Sets the appended text before the annotation
SetBelow Sets the appended text below the annotation
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

UserDefinedSymbolAspectRatio

AppendedTextBuilder.UserDefinedSymbolAspectRatio

Returns or sets the aspect ratio for user defined symbol

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

Getter Method

Signature UserDefinedSymbolAspectRatio

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature UserDefinedSymbolAspectRatio

Parameters:aspectRatio (float) –

New in version NX11.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

UserDefinedSymbolHeight

AppendedTextBuilder.UserDefinedSymbolHeight

Returns or sets the height for user defined symbol

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

Getter Method

Signature UserDefinedSymbolHeight

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature UserDefinedSymbolHeight

Parameters:height (float) –

New in version NX11.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

UserDefinedSymbolLength

AppendedTextBuilder.UserDefinedSymbolLength

Returns or sets the length for user defined symbol

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

Getter Method

Signature UserDefinedSymbolLength

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature UserDefinedSymbolLength

Parameters:length (float) –

New in version NX11.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

UserDefinedSymbolScale

AppendedTextBuilder.UserDefinedSymbolScale

Returns or sets the scale for user defined symbol

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

Getter Method

Signature UserDefinedSymbolScale

Returns:
Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature UserDefinedSymbolScale

Parameters:scale (float) –

New in version NX11.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

Method Detail

GetAbove

AppendedTextBuilder.GetAbove

Gets the appended text above the annotation

Signature GetAbove()

Returns:List of lines
Return type:list of str

New in version NX9.0.0.

License requirements: None.

GetAfter

AppendedTextBuilder.GetAfter

Gets the appended text after the annotation

Signature GetAfter()

Returns:List of lines
Return type:list of str

New in version NX9.0.0.

License requirements: None.

GetBefore

AppendedTextBuilder.GetBefore

Gets the appended text before the annotation

Signature GetBefore()

Returns:List of lines
Return type:list of str

New in version NX9.0.0.

License requirements: None.

GetBelow

AppendedTextBuilder.GetBelow

Gets the appended text below the annotation

Signature GetBelow()

Returns:List of lines
Return type:list of str

New in version NX9.0.0.

License requirements: None.

SetAbove

AppendedTextBuilder.SetAbove

Sets the appended text above the annotation

Signature SetAbove(lines)

Parameters:lines (list of str) – List of new lines

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

SetAfter

AppendedTextBuilder.SetAfter

Sets the appended text after the annotation

Signature SetAfter(lines)

Parameters:lines (list of str) – List of new lines

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

SetBefore

AppendedTextBuilder.SetBefore

Sets the appended text before the annotation

Signature SetBefore(lines)

Parameters:lines (list of str) – List of new lines

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

SetBelow

AppendedTextBuilder.SetBelow

Sets the appended text below the annotation

Signature SetBelow(lines)

Parameters:lines (list of str) – List of new lines

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

Validate

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