TextStyleBuilder Class

class NXOpen.Diagramming.TextStyleBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a TextStyleBuilder.

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

New in version NX11.0.0.

Properties

Property	Description
Tag	Returns the Tag for this object.
TextAlignment	Returns or sets the text alignment of the annotation
TextAllowWrapping	Returns or sets the text allow wrapping
TextAutoFit	Returns or sets the text auto fit
TextColorFontWidth	Returns the text color font width
TextHeight	Returns or sets the height of the annotation
TextOverlined	Returns or sets whether the text is overlined
TextUnderlined	Returns or sets whether the text is underlined

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

TextStyleBuilderTextAlignmentType Enumeration	Represents the option NXOpen.Diagramming.TextStyleBuilder.TextAlignment() for a NXOpen.Diagramming.TextStyleBuilder.
TextStyleBuilderTextAutoFitType Enumeration	Represents the option for a NXOpen.Diagramming.TextStyleBuilder.

Property Detail

TextAlignment

TextStyleBuilder.TextAlignment

Returns or sets the text alignment of the annotation

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

Getter Method

Signature TextAlignment

Returns: Return type:NXOpen.Diagramming.TextStyleBuilderTextAlignmentType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextAlignment

Parameters:alignment (NXOpen.Diagramming.TextStyleBuilderTextAlignmentType) –

New in version NX11.0.0.

License requirements: None.

TextAllowWrapping

TextStyleBuilder.TextAllowWrapping

Returns or sets the text allow wrapping

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

Getter Method

Signature TextAllowWrapping

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextAllowWrapping

Parameters:allowWrapping (bool) –

New in version NX11.0.0.

License requirements: None.

TextAutoFit

TextStyleBuilder.TextAutoFit

Returns or sets the text auto fit

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

Getter Method

Signature TextAutoFit

Returns: Return type:NXOpen.Diagramming.TextStyleBuilderTextAutoFitType

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextAutoFit

Parameters:autoFit (NXOpen.Diagramming.TextStyleBuilderTextAutoFitType) –

New in version NX11.0.0.

License requirements: None.

TextColorFontWidth

TextStyleBuilder.TextColorFontWidth

Returns the text color font width

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

Getter Method

Signature TextColorFontWidth

Returns: Return type:NXOpen.TextColorFontWidthBuilder

New in version NX11.0.0.

License requirements: None.

TextHeight

TextStyleBuilder.TextHeight

Returns or sets the height of the annotation

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

Getter Method

Signature TextHeight

Returns: Return type:float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextHeight

Parameters:height (float) –

New in version NX11.0.0.

License requirements: None.

TextOverlined

TextStyleBuilder.TextOverlined

Returns or sets whether the text is overlined

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

Getter Method

Signature TextOverlined

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextOverlined

Parameters:overlined (bool) –

New in version NX11.0.0.

License requirements: None.

TextUnderlined

TextStyleBuilder.TextUnderlined

Returns or sets whether the text is underlined

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

Getter Method

Signature TextUnderlined

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature TextUnderlined

Parameters:underlined (bool) –

New in version NX11.0.0.

License requirements: None.

Method Detail

Validate

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