LetteringStyleBuilder Class¶
-
class
NXOpen.Annotations.
LetteringStyleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.LetteringStyleBuilder
.This class queries and sets lettering preferences when creating or editing annotations.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AlignPosition | Returns or sets the alignment position |
Angle | Returns or sets the angle for general text |
AppendedNxTextCharacterSpaceFactor | Returns or sets the appended NX text character space factor. |
AppendedStandardTextCharacterSpaceFactor | Returns or sets the appended Standard text character space factor. |
AppendedTextAspectRatio | Returns or sets the appended text aspect ratio. |
AppendedTextCharSpaceFactor | Returns or sets the appended text character space factor. |
AppendedTextColor | Returns or sets the appended text color |
AppendedTextFont | Returns or sets the appended text font |
AppendedTextItalicized | Returns or sets the appended text italic status |
AppendedTextLineSpaceFactor | Returns or sets the appended text line space factor |
AppendedTextLineWidth | Returns or sets the appended text line width. |
AppendedTextSize | Returns or sets the appended text character size |
AppendedTextSpaceFactor | Returns or sets the appended text space factor. |
AppendedTextSymbolAspectRatio | Returns or sets the symbol aspect ratio for appended text (only available for symbols when using standard font). |
DimLineSpaceFactor | Returns or sets the dimension line space factor. |
DimensionNxTextCharacterSpaceFactor | Returns or sets the dimension NX text character space factor. |
DimensionStandardTextCharacterSpaceFactor | Returns or sets the dimension Standard text character space factor. |
DimensionTextAspectRatio | Returns or sets the dimension text aspect ratio. |
DimensionTextCharSpaceFactor | Returns or sets the dimension text space factor. |
DimensionTextColor | Returns or sets the dimension text color |
DimensionTextFont | Returns or sets the dimension text font |
DimensionTextItalicized | Returns or sets the dimension text italic status |
DimensionTextLineSpaceFactor | Returns or sets the dimension text line space factor |
DimensionTextLineWidth | Returns or sets the dimension text line width. |
DimensionTextSize | Returns or sets the dimension text character size |
DimensionTextSymbolAspectRatio | Returns or sets the symbol aspect ratio for dimension text (only available for symbols when using standard font). |
GdtFrameHeightFactor | Returns or sets the GD and T frame height factor |
GeneralNxTextCharacterSpaceFactor | Returns or sets the general NX text character space factor. |
GeneralStandardTextCharacterSpaceFactor | Returns or sets the general Standard text character space factor. |
GeneralTextAspectRatio | Returns or sets the general text aspect ratio. |
GeneralTextCharSpaceFactor | Returns or sets the general text character space factor. |
GeneralTextColor | Returns or sets the general text color |
GeneralTextFont | Returns or sets the general text font |
GeneralTextItalicized | Returns or sets the general text italic status |
GeneralTextLineSpaceFactor | Returns or sets the general text line space factor |
GeneralTextLineWidth | Returns or sets the general text line width. |
GeneralTextSize | Returns or sets the general text character size |
GeneralTextSymbolAspectRatio | Returns or sets the symbol aspect ratio for general text (only available for symbols when using standard font). |
HorizontalTextJustification | Returns or sets the horizontal text justification |
StackAboveSpaceFactor | Returns or sets the stack above space factor. |
StackAutospace | Returns or sets the stack autospace setting. |
StackBelowSpaceFactor | Returns or sets the stack below space factor. |
StackHorizontalAlignment | Returns or sets the stack horizontal alignment |
StackInheritAssociatedObjects | Returns or sets the stack inherit associated objects setting. |
StackLeftSpaceFactor | Returns or sets the stack left space factor. |
StackRightSpaceFactor | Returns or sets the stack right space factor. |
StackVerticalAlignment | Returns or sets the stack vertical alignment |
SymbolFontFile | Returns or sets the symbol font file setting. |
Tag | Returns the Tag for this object. |
ToleranceNxTextCharacterSpaceFactor | Returns or sets the tolerance NX text character space factor. |
ToleranceStandardTextCharacterSpaceFactor | Returns or sets the tolerance Standard text character space factor. |
ToleranceTextAspectRatio | Returns or sets the tolerance text aspect ratio. |
ToleranceTextCharSpaceFactor | Returns or sets the tolerance text character space factor. |
ToleranceTextColor | Returns or sets the tolerance text color |
ToleranceTextFont | Returns or sets the tolerance text font |
ToleranceTextItalicized | Returns or sets the tolerance text italic status |
ToleranceTextLineSpaceFactor | Returns or sets the tolerance text line space factor |
ToleranceTextLineWidth | Returns or sets the tolerance text line width. |
ToleranceTextSize | Returns or sets the tolerance text character size |
ToleranceTextSpaceFactor | Returns or sets the tolerance text space factor. |
ToleranceTextSymbolAspectRatio | Returns or sets the symbol aspect ratio for tolerance text (only available for symbols when using standard font). |
TwoLineToleranceTextSize | Returns or sets the two-line tolerance text character size |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AlignPosition¶
-
LetteringStyleBuilder.
AlignPosition
¶ Returns or sets the alignment position
-------------------------------------
Getter Method
Signature
AlignPosition()
Returns: Return type: NXOpen.Annotations.AlignmentPosition
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignPosition(alignPosition)
Parameters: alignPosition ( NXOpen.Annotations.AlignmentPosition
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Angle¶
-
LetteringStyleBuilder.
Angle
¶ Returns or sets the angle for general text
-------------------------------------
Getter Method
Signature
Angle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Angle(angle)
Parameters: angle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedNxTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
AppendedNxTextCharacterSpaceFactor
¶ Returns or sets the appended NX text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the NX font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
AppendedNxTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedNxTextCharacterSpaceFactor(appendedNXTextCharSpaceFactor)
Parameters: appendedNXTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedStandardTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
AppendedStandardTextCharacterSpaceFactor
¶ Returns or sets the appended Standard text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the Standard font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
AppendedStandardTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedStandardTextCharacterSpaceFactor(appendedStandardTextCharSpaceFactor)
Parameters: appendedStandardTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextAspectRatio¶
-
LetteringStyleBuilder.
AppendedTextAspectRatio
¶ Returns or sets the appended text aspect ratio.
This specifies a ratio of length to height which represents the size of character text. This only defines the aspect ratio for text.
LetteringStyleBuilder.AppendedTextSymbolAspectRatio`()
controls the aspect ratio of symbol text control sequences.-------------------------------------
Getter Method
Signature
AppendedTextAspectRatio()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextAspectRatio(appendedTextAspectRatio)
Parameters: appendedTextAspectRatio (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextCharSpaceFactor¶
-
LetteringStyleBuilder.
AppendedTextCharSpaceFactor
¶ Returns or sets the appended text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the current font
-------------------------------------
Getter Method
Signature
AppendedTextCharSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextCharSpaceFactor(appendedTextCharSpaceFactor)
Parameters: appendedTextCharSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextColor¶
-
LetteringStyleBuilder.
AppendedTextColor
¶ Returns or sets the appended text color
-------------------------------------
Getter Method
Signature
AppendedTextColor()
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextColor(appendedTextColor)
Parameters: appendedTextColor (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextFont¶
-
LetteringStyleBuilder.
AppendedTextFont
¶ Returns or sets the appended text font
-------------------------------------
Getter Method
Signature
AppendedTextFont()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextFont(appendedTextFont)
Parameters: appendedTextFont (int) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextItalicized¶
-
LetteringStyleBuilder.
AppendedTextItalicized
¶ Returns or sets the appended text italic status
-------------------------------------
Getter Method
Signature
AppendedTextItalicized()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextItalicized(appendedTextItalicized)
Parameters: appendedTextItalicized (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextLineSpaceFactor¶
-
LetteringStyleBuilder.
AppendedTextLineSpaceFactor
¶ Returns or sets the appended text line space factor
-------------------------------------
Getter Method
Signature
AppendedTextLineSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextLineSpaceFactor(appendedTextLineSpaceFactor)
Parameters: appendedTextLineSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextLineWidth¶
-
LetteringStyleBuilder.
AppendedTextLineWidth
¶ Returns or sets the appended text line width.
The values for
NXOpen.Annotations.LineWidth
when using standard font : A value ofNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Regular” or “Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.AppendedTextItalicized`()
is set). Any value other thanNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Bold” or “Bold Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.AppendedTextItalicized`()
is set).-------------------------------------
Getter Method
Signature
AppendedTextLineWidth()
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextLineWidth(appendedTextLineWidth)
Parameters: appendedTextLineWidth ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextSize¶
-
LetteringStyleBuilder.
AppendedTextSize
¶ Returns or sets the appended text character size
-------------------------------------
Getter Method
Signature
AppendedTextSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextSize(appendedTextSize)
Parameters: appendedTextSize (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextSpaceFactor¶
-
LetteringStyleBuilder.
AppendedTextSpaceFactor
¶ Returns or sets the appended text space factor.
This controls the spacing between the before appended text and the next piece of dimension text to its right; and the spacing between the after appended text and the next piece of text to its left. The space is equal to the appended text character size multiplied by the space factor
-------------------------------------
Getter Method
Signature
AppendedTextSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextSpaceFactor(appendedTextSpaceFactor)
Parameters: appendedTextSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
AppendedTextSymbolAspectRatio¶
-
LetteringStyleBuilder.
AppendedTextSymbolAspectRatio
¶ Returns or sets the symbol aspect ratio for appended text (only available for symbols when using standard font).
This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the <O> text control sequence), the counterbore symbol (represented by the <#C> text control sequence), the degree symbol (represented by the <$s> text control sequence), the true position symbol (represented by the <&10> text control sequence), etc.
-------------------------------------
Getter Method
Signature
AppendedTextSymbolAspectRatio()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AppendedTextSymbolAspectRatio(appendedTextSymbolAspect)
Parameters: appendedTextSymbolAspect (float) – New in version NX11.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimLineSpaceFactor¶
-
LetteringStyleBuilder.
DimLineSpaceFactor
¶ Returns or sets the dimension line space factor.
This controls the spacing between the bottom most piece of text on the dimension and the dimension line. This only applies when the text orientation is text over dimension line. The space is equal to the dimension text character size multiplied by the space factor
-------------------------------------
Getter Method
Signature
DimLineSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimLineSpaceFactor(dimLineSpaceFactor)
Parameters: dimLineSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionNxTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
DimensionNxTextCharacterSpaceFactor
¶ Returns or sets the dimension NX text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the NX font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
DimensionNxTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionNxTextCharacterSpaceFactor(dimensionNXTextCharSpaceFactor)
Parameters: dimensionNXTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionStandardTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
DimensionStandardTextCharacterSpaceFactor
¶ Returns or sets the dimension Standard text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the Standard font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
DimensionStandardTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionStandardTextCharacterSpaceFactor(dimensionStandardTextCharSpaceFactor)
Parameters: dimensionStandardTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextAspectRatio¶
-
LetteringStyleBuilder.
DimensionTextAspectRatio
¶ Returns or sets the dimension text aspect ratio.
This specifies a ratio of length to height which represents the size of character text. This only defines the aspect ratio for text.
LetteringStyleBuilder.DimensionTextSymbolAspectRatio`()
controls the aspect ratio of symbol text control sequences.-------------------------------------
Getter Method
Signature
DimensionTextAspectRatio()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextAspectRatio(dimensionTextAspectRatio)
Parameters: dimensionTextAspectRatio (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextCharSpaceFactor¶
-
LetteringStyleBuilder.
DimensionTextCharSpaceFactor
¶ Returns or sets the dimension text space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the current font
-------------------------------------
Getter Method
Signature
DimensionTextCharSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextCharSpaceFactor(dimensionTextCharSpaceFactor)
Parameters: dimensionTextCharSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextColor¶
-
LetteringStyleBuilder.
DimensionTextColor
¶ Returns or sets the dimension text color
-------------------------------------
Getter Method
Signature
DimensionTextColor()
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextColor(dimensionTextColor)
Parameters: dimensionTextColor (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextFont¶
-
LetteringStyleBuilder.
DimensionTextFont
¶ Returns or sets the dimension text font
-------------------------------------
Getter Method
Signature
DimensionTextFont()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextFont(dimensionTextFont)
Parameters: dimensionTextFont (int) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextItalicized¶
-
LetteringStyleBuilder.
DimensionTextItalicized
¶ Returns or sets the dimension text italic status
-------------------------------------
Getter Method
Signature
DimensionTextItalicized()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextItalicized(dimensionTextItalic)
Parameters: dimensionTextItalic (bool) – New in version NX8.5.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextLineSpaceFactor¶
-
LetteringStyleBuilder.
DimensionTextLineSpaceFactor
¶ Returns or sets the dimension text line space factor
-------------------------------------
Getter Method
Signature
DimensionTextLineSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextLineSpaceFactor(dimensionTextLineSpaceFactor)
Parameters: dimensionTextLineSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextLineWidth¶
-
LetteringStyleBuilder.
DimensionTextLineWidth
¶ Returns or sets the dimension text line width.
The values for
NXOpen.Annotations.LineWidth
when using standard font : A value ofNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Regular” or “Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.DimensionTextItalicized`()
is set). Any value other thanNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Bold” or “Bold Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.DimensionTextItalicized`()
is set).-------------------------------------
Getter Method
Signature
DimensionTextLineWidth()
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextLineWidth(dimensionTextLineWidth)
Parameters: dimensionTextLineWidth ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextSize¶
-
LetteringStyleBuilder.
DimensionTextSize
¶ Returns or sets the dimension text character size
-------------------------------------
Getter Method
Signature
DimensionTextSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextSize(dimensionTextSize)
Parameters: dimensionTextSize (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DimensionTextSymbolAspectRatio¶
-
LetteringStyleBuilder.
DimensionTextSymbolAspectRatio
¶ Returns or sets the symbol aspect ratio for dimension text (only available for symbols when using standard font).
This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the <O> text control sequence), the counterbore symbol (represented by the <#C> text control sequence), the degree symbol (represented by the <$s> text control sequence), the true position symbol (represented by the <&10> text control sequence), etc.
-------------------------------------
Getter Method
Signature
DimensionTextSymbolAspectRatio()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionTextSymbolAspectRatio(dimensionTextSymbolAspect)
Parameters: dimensionTextSymbolAspect (float) – New in version NX11.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GdtFrameHeightFactor¶
-
LetteringStyleBuilder.
GdtFrameHeightFactor
¶ Returns or sets the GD and T frame height factor
-------------------------------------
Getter Method
Signature
GdtFrameHeightFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GdtFrameHeightFactor(gdtFrameHeightFactor)
Parameters: gdtFrameHeightFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralNxTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
GeneralNxTextCharacterSpaceFactor
¶ Returns or sets the general NX text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the NX font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
GeneralNxTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralNxTextCharacterSpaceFactor(generalNXTextCharSpaceFactor)
Parameters: generalNXTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralStandardTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
GeneralStandardTextCharacterSpaceFactor
¶ Returns or sets the general Standard text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the Standard font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
GeneralStandardTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralStandardTextCharacterSpaceFactor(generalStandardTextCharSpaceFactor)
Parameters: generalStandardTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextAspectRatio¶
-
LetteringStyleBuilder.
GeneralTextAspectRatio
¶ Returns or sets the general text aspect ratio.
This specifies a ratio of length to height which represents the size of character text. This only defines the aspect ratio for text.
LetteringStyleBuilder.GeneralTextSymbolAspectRatio`()
controls the aspect ratio of symbol text control sequences.-------------------------------------
Getter Method
Signature
GeneralTextAspectRatio()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextAspectRatio(generalTextAspectRatio)
Parameters: generalTextAspectRatio (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextCharSpaceFactor¶
-
LetteringStyleBuilder.
GeneralTextCharSpaceFactor
¶ Returns or sets the general text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the current font
-------------------------------------
Getter Method
Signature
GeneralTextCharSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextCharSpaceFactor(generalTextCharSpaceFactor)
Parameters: generalTextCharSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextColor¶
-
LetteringStyleBuilder.
GeneralTextColor
¶ Returns or sets the general text color
-------------------------------------
Getter Method
Signature
GeneralTextColor()
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextColor(generalTextColor)
Parameters: generalTextColor (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextFont¶
-
LetteringStyleBuilder.
GeneralTextFont
¶ Returns or sets the general text font
-------------------------------------
Getter Method
Signature
GeneralTextFont()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextFont(generalTextFont)
Parameters: generalTextFont (int) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextItalicized¶
-
LetteringStyleBuilder.
GeneralTextItalicized
¶ Returns or sets the general text italic status
-------------------------------------
Getter Method
Signature
GeneralTextItalicized()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextItalicized(generalTextItalicized)
Parameters: generalTextItalicized (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextLineSpaceFactor¶
-
LetteringStyleBuilder.
GeneralTextLineSpaceFactor
¶ Returns or sets the general text line space factor
-------------------------------------
Getter Method
Signature
GeneralTextLineSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextLineSpaceFactor(generalTextLineSpaceFactor)
Parameters: generalTextLineSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextLineWidth¶
-
LetteringStyleBuilder.
GeneralTextLineWidth
¶ Returns or sets the general text line width.
The values for
NXOpen.Annotations.LineWidth
when using standard font : A value ofNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Regular” or “Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.GeneralTextItalicized`()
is set). Any value other thanNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Bold” or “Bold Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.GeneralTextItalicized`()
is set).-------------------------------------
Getter Method
Signature
GeneralTextLineWidth()
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextLineWidth(generalTextLineWidth)
Parameters: generalTextLineWidth ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextSize¶
-
LetteringStyleBuilder.
GeneralTextSize
¶ Returns or sets the general text character size
-------------------------------------
Getter Method
Signature
GeneralTextSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextSize(generalTextSize)
Parameters: generalTextSize (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
GeneralTextSymbolAspectRatio¶
-
LetteringStyleBuilder.
GeneralTextSymbolAspectRatio
¶ Returns or sets the symbol aspect ratio for general text (only available for symbols when using standard font).
This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the <O> text control sequence), the counterbore symbol (represented by the <#C> text control sequence), the degree symbol (represented by the <$s> text control sequence), the true position symbol (represented by the <&10> text control sequence), etc.
-------------------------------------
Getter Method
Signature
GeneralTextSymbolAspectRatio()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeneralTextSymbolAspectRatio(generalTextSymbolAspect)
Parameters: generalTextSymbolAspect (float) – New in version NX11.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
HorizontalTextJustification¶
-
LetteringStyleBuilder.
HorizontalTextJustification
¶ Returns or sets the horizontal text justification
-------------------------------------
Getter Method
Signature
HorizontalTextJustification()
Returns: Return type: NXOpen.Annotations.TextJustification
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalTextJustification(horizontalTextJustification)
Parameters: horizontalTextJustification ( NXOpen.Annotations.TextJustification
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackAboveSpaceFactor¶
-
LetteringStyleBuilder.
StackAboveSpaceFactor
¶ Returns or sets the stack above space factor.
This specifies the space buffer above the annotation within a stack as a factor of a multiple of the character size
-------------------------------------
Getter Method
Signature
StackAboveSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackAboveSpaceFactor(stackAboveSpaceFactor)
Parameters: stackAboveSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackAutospace¶
-
LetteringStyleBuilder.
StackAutospace
¶ Returns or sets the stack autospace setting.
A value of True means that system defined spacing values will be used when a symbol is inserted into a stack
-------------------------------------
Getter Method
Signature
StackAutospace()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackAutospace(stackAutospace)
Parameters: stackAutospace (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackBelowSpaceFactor¶
-
LetteringStyleBuilder.
StackBelowSpaceFactor
¶ Returns or sets the stack below space factor.
This specifies the space buffer below the annotation within a stack as a factor of a multiple of the character size
-------------------------------------
Getter Method
Signature
StackBelowSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackBelowSpaceFactor(stackBelowSpaceFactor)
Parameters: stackBelowSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackHorizontalAlignment¶
-
LetteringStyleBuilder.
StackHorizontalAlignment
¶ Returns or sets the stack horizontal alignment
-------------------------------------
Getter Method
Signature
StackHorizontalAlignment()
Returns: Return type: NXOpen.Annotations.StackHorizontalAlignment
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackHorizontalAlignment(stackHorizontalAlignment)
Parameters: stackHorizontalAlignment ( NXOpen.Annotations.StackHorizontalAlignment
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackInheritAssociatedObjects¶
-
LetteringStyleBuilder.
StackInheritAssociatedObjects
¶ Returns or sets the stack inherit associated objects setting.
A value of True means that a PMI annotation when added to a stack will automatically inherit the associated objects of the stack
-------------------------------------
Getter Method
Signature
StackInheritAssociatedObjects()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackInheritAssociatedObjects(stackInheritAssociatedObjects)
Parameters: stackInheritAssociatedObjects (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackLeftSpaceFactor¶
-
LetteringStyleBuilder.
StackLeftSpaceFactor
¶ Returns or sets the stack left space factor.
This specifies the space buffer to the left of the annotation within a stack as a factor of a multiple of the character size
-------------------------------------
Getter Method
Signature
StackLeftSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackLeftSpaceFactor(stackLeftSpaceFactor)
Parameters: stackLeftSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackRightSpaceFactor¶
-
LetteringStyleBuilder.
StackRightSpaceFactor
¶ Returns or sets the stack right space factor.
This specifies the space buffer to the rght of the annotation within a stack as a factor of a multiple of the character size
-------------------------------------
Getter Method
Signature
StackRightSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackRightSpaceFactor(stackRightSpaceFactor)
Parameters: stackRightSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
StackVerticalAlignment¶
-
LetteringStyleBuilder.
StackVerticalAlignment
¶ Returns or sets the stack vertical alignment
-------------------------------------
Getter Method
Signature
StackVerticalAlignment()
Returns: Return type: NXOpen.Annotations.StackVerticalAlignment
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StackVerticalAlignment(stackVerticalAlignment)
Parameters: stackVerticalAlignment ( NXOpen.Annotations.StackVerticalAlignment
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolFontFile¶
-
LetteringStyleBuilder.
SymbolFontFile
¶ Returns or sets the symbol font file setting.
This is global preferences setting.
-------------------------------------
Getter Method
Signature
SymbolFontFile()
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolFontFile(symbolFontFile)
Parameters: symbolFontFile (str) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceNxTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
ToleranceNxTextCharacterSpaceFactor
¶ Returns or sets the tolerance NX text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the NX font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
ToleranceNxTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceNxTextCharacterSpaceFactor(toleranceNXTextCharSpaceFactor)
Parameters: toleranceNXTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceStandardTextCharacterSpaceFactor¶
-
LetteringStyleBuilder.
ToleranceStandardTextCharacterSpaceFactor
¶ Returns or sets the tolerance Standard text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the Standard font. This setting is specific to preferences and object style in create mode.
-------------------------------------
Getter Method
Signature
ToleranceStandardTextCharacterSpaceFactor()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceStandardTextCharacterSpaceFactor(toleranceStandardTextCharSpaceFactor)
Parameters: toleranceStandardTextCharSpaceFactor (float) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextAspectRatio¶
-
LetteringStyleBuilder.
ToleranceTextAspectRatio
¶ Returns or sets the tolerance text aspect ratio.
This specifies a ratio of length to height which represents the size of character text. This only defines the aspect ratio for text.
LetteringStyleBuilder.ToleranceTextSymbolAspectRatio`()
controls the aspect ratio of symbol text control sequences.-------------------------------------
Getter Method
Signature
ToleranceTextAspectRatio()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextAspectRatio(toleranceTextAspectRatio)
Parameters: toleranceTextAspectRatio (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextCharSpaceFactor¶
-
LetteringStyleBuilder.
ToleranceTextCharSpaceFactor
¶ Returns or sets the tolerance text character space factor.
This defines the spacing between characters in text as a multiple of the standard character spacing for the current font
-------------------------------------
Getter Method
Signature
ToleranceTextCharSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextCharSpaceFactor(toleranceTextCharSpaceFactor)
Parameters: toleranceTextCharSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextColor¶
-
LetteringStyleBuilder.
ToleranceTextColor
¶ Returns or sets the tolerance text color
-------------------------------------
Getter Method
Signature
ToleranceTextColor()
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextColor(toleranceTextColor)
Parameters: toleranceTextColor (Id) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextFont¶
-
LetteringStyleBuilder.
ToleranceTextFont
¶ Returns or sets the tolerance text font
-------------------------------------
Getter Method
Signature
ToleranceTextFont()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextFont(toleranceTextFont)
Parameters: toleranceTextFont (int) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextItalicized¶
-
LetteringStyleBuilder.
ToleranceTextItalicized
¶ Returns or sets the tolerance text italic status
-------------------------------------
Getter Method
Signature
ToleranceTextItalicized()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextItalicized(toleranceTextItalicized)
Parameters: toleranceTextItalicized (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextLineSpaceFactor¶
-
LetteringStyleBuilder.
ToleranceTextLineSpaceFactor
¶ Returns or sets the tolerance text line space factor
-------------------------------------
Getter Method
Signature
ToleranceTextLineSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextLineSpaceFactor(toleranceTextLineSpaceFactor)
Parameters: toleranceTextLineSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextLineWidth¶
-
LetteringStyleBuilder.
ToleranceTextLineWidth
¶ Returns or sets the tolerance text line width.
The values for
NXOpen.Annotations.LineWidth
when using standard font : A value ofNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Regular” or “Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.ToleranceTextItalicized`()
is set). Any value other thanNXOpen.Annotations.LineWidth.Thin
is equivalent to a value of “Bold” or “Bold Italic” (ifNXOpen.Annotations.LetteringStyleBuilder.ToleranceTextItalicized`()
is set).-------------------------------------
Getter Method
Signature
ToleranceTextLineWidth()
Returns: Return type: NXOpen.Annotations.LineWidth
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextLineWidth(toleranceTextLineWidth)
Parameters: toleranceTextLineWidth ( NXOpen.Annotations.LineWidth
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextSize¶
-
LetteringStyleBuilder.
ToleranceTextSize
¶ Returns or sets the tolerance text character size
-------------------------------------
Getter Method
Signature
ToleranceTextSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextSize(toleranceTextSize)
Parameters: toleranceTextSize (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextSpaceFactor¶
-
LetteringStyleBuilder.
ToleranceTextSpaceFactor
¶ Returns or sets the tolerance text space factor.
This contols the spacing between the dimension main text and the after tolerance text. The space is equal to the tolerance text character size multiplied by the space factor
-------------------------------------
Getter Method
Signature
ToleranceTextSpaceFactor()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextSpaceFactor(toleranceTextSpaceFactor)
Parameters: toleranceTextSpaceFactor (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ToleranceTextSymbolAspectRatio¶
-
LetteringStyleBuilder.
ToleranceTextSymbolAspectRatio
¶ Returns or sets the symbol aspect ratio for tolerance text (only available for symbols when using standard font).
This value controls the aspect ratio of text control sequences such as the diameter symbol (represented by the <O> text control sequence), the counterbore symbol (represented by the <#C> text control sequence), the degree symbol (represented by the <$s> text control sequence), the true position symbol (represented by the <&10> text control sequence), etc.
-------------------------------------
Getter Method
Signature
ToleranceTextSymbolAspectRatio()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceTextSymbolAspectRatio(toleranceTextSymbolAspect)
Parameters: toleranceTextSymbolAspect (float) – New in version NX11.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
TwoLineToleranceTextSize¶
-
LetteringStyleBuilder.
TwoLineToleranceTextSize
¶ Returns or sets the two-line tolerance text character size
-------------------------------------
Getter Method
Signature
TwoLineToleranceTextSize()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TwoLineToleranceTextSize(twoLineToleranceTextSize)
Parameters: twoLineToleranceTextSize (float) – New in version NX11.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
LetteringStyleBuilder.
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.