SymbolStyleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SymbolStyleBuilder Class

class `NXOpen.Annotations.``SymbolStyleBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Annotations.SymbolStyleBuilder`.

  This class queries and sets preferences for various symbol type annotations when creating or editing.

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
AttachToIdSymbolVertex | Returns or sets the id symbol attachment method
CenterlineSymbolColor | Returns or sets the centerline symbol color
CenterlineSymbolWidth | Returns or sets the centerline symbol width
DraftingSurfaceFinishStandard | Returns or sets the standard
FcfAdditionalTextUnderline | Returns or sets the option to underline the additional FCF text
GdtSymbolColor | Returns or sets the GD and T symbol color
GdtSymbolFont | Returns or sets the GD and T symbol font
GdtSymbolWidth | Returns or sets the GD and T symbol width
IdSymbolColor | Returns or sets the ID symbol color
IdSymbolFont | Returns or sets the ID symbol font
IdSymbolSize | Returns or sets the ID symbol size
IdSymbolWidth | Returns or sets the ID symbol width
IntersectionSymbolColor | Returns or sets the intersection symbol color
IntersectionSymbolFont | Returns or sets the intersection symbol font
IntersectionSymbolWidth | Returns or sets the intersection symbol width
SurfaceFinishColor | Returns or sets the surface finish symbol color
SurfaceFinishFont | Returns or sets the surface finish symbol font
SurfaceFinishWidth | Returns or sets the surface finish symbol width
Tag | Returns the Tag for this object.
TargetSymbolColor | Returns or sets the target symbol color
TargetSymbolFont | Returns or sets the target symbol font
TargetSymbolWidth | Returns or sets the target symbol width
UserDefinedSymbolColor | Returns or sets the user defined symbol color
UserDefinedSymbolFont | Returns or sets the user defined symbol font
UserDefinedSymbolWidth | Returns or sets the user defined symbol width
WeldLineGap | Returns or sets the gap between the weld line and weld type symbol
WeldSpaceFactor | Returns or sets the weld space factor
WeldSymbolColor | Returns or sets the Weld symbol color
WeldSymbolFont | Returns or sets the Weld symbol font
WeldSymbolSizeFactor | Returns or sets the character size factor that controls the weld symbol size.
WeldSymbolStandard | Returns or sets the weld symbol standard
WeldSymbolWidth | Returns or sets the Weld symbol width

# Methods

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

# Enumerations

SymbolStyleBuilderFcfTextUnderlineOption Enumeration | Represents the option to underline the additional FCF text

# Property Detail

## AttachToIdSymbolVertex

`SymbolStyleBuilder.``AttachToIdSymbolVertex`

  Returns or sets the id symbol attachment method

  `-------------------------------------`

  Getter Method

  Signature `AttachToIdSymbolVertex`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AttachToIdSymbolVertex`

  Parameters: | attachToIdSymbolVertex (bool) –

  New in version NX10.0.0.

  License requirements: None.

## CenterlineSymbolColor

`SymbolStyleBuilder.``CenterlineSymbolColor`

  Returns or sets the centerline symbol color

  `-------------------------------------`

  Getter Method

  Signature `CenterlineSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenterlineSymbolColor`

  Parameters: | centerlineSymbolColor (Id) –

  New in version NX6.0.0.

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

## CenterlineSymbolWidth

`SymbolStyleBuilder.``CenterlineSymbolWidth`

  Returns or sets the centerline symbol width

  `-------------------------------------`

  Getter Method

  Signature `CenterlineSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenterlineSymbolWidth`

  Parameters: | centerlineSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## DraftingSurfaceFinishStandard

`SymbolStyleBuilder.``DraftingSurfaceFinishStandard`

  Returns or sets the standard

  `-------------------------------------`

  Getter Method

  Signature `DraftingSurfaceFinishStandard`

  Returns: |
  Return type: | `NXOpen.Annotations.SurfaceFinishStandard`

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DraftingSurfaceFinishStandard`

  Parameters: | standard (`NXOpen.Annotations.SurfaceFinishStandard`) –

  New in version NX7.5.0.

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

## FcfAdditionalTextUnderline

`SymbolStyleBuilder.``FcfAdditionalTextUnderline`

  Returns or sets the option to underline the additional FCF text

  `-------------------------------------`

  Getter Method

  Signature `FcfAdditionalTextUnderline`

  Returns: |
  Return type: | `NXOpen.Annotations.SymbolStyleBuilderFcfTextUnderlineOption`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FcfAdditionalTextUnderline`

  Parameters: | underlineTextOption (`NXOpen.Annotations.SymbolStyleBuilderFcfTextUnderlineOption`) –

  New in version NX10.0.0.

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

## GdtSymbolColor

`SymbolStyleBuilder.``GdtSymbolColor`

  Returns or sets the GD and T symbol color

  `-------------------------------------`

  Getter Method

  Signature `GdtSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `GdtSymbolColor`

  Parameters: | gdtSymbolColor (Id) –

  New in version NX6.0.0.

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

## GdtSymbolFont

`SymbolStyleBuilder.``GdtSymbolFont`

  Returns or sets the GD and T symbol font

  `-------------------------------------`

  Getter Method

  Signature `GdtSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `GdtSymbolFont`

  Parameters: | gdtSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## GdtSymbolWidth

`SymbolStyleBuilder.``GdtSymbolWidth`

  Returns or sets the GD and T symbol width

  `-------------------------------------`

  Getter Method

  Signature `GdtSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `GdtSymbolWidth`

  Parameters: | gdtSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## IdSymbolColor

`SymbolStyleBuilder.``IdSymbolColor`

  Returns or sets the ID symbol color

  `-------------------------------------`

  Getter Method

  Signature `IdSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IdSymbolColor`

  Parameters: | idSymbolColor (Id) –

  New in version NX6.0.0.

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

## IdSymbolFont

`SymbolStyleBuilder.``IdSymbolFont`

  Returns or sets the ID symbol font

  `-------------------------------------`

  Getter Method

  Signature `IdSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IdSymbolFont`

  Parameters: | idSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## IdSymbolSize

`SymbolStyleBuilder.``IdSymbolSize`

  Returns or sets the ID symbol size

  `-------------------------------------`

  Getter Method

  Signature `IdSymbolSize`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IdSymbolSize`

  Parameters: | idSymbolSize (float) –

  New in version NX6.0.0.

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

## IdSymbolWidth

`SymbolStyleBuilder.``IdSymbolWidth`

  Returns or sets the ID symbol width

  `-------------------------------------`

  Getter Method

  Signature `IdSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IdSymbolWidth`

  Parameters: | idSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## IntersectionSymbolColor

`SymbolStyleBuilder.``IntersectionSymbolColor`

  Returns or sets the intersection symbol color

  `-------------------------------------`

  Getter Method

  Signature `IntersectionSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IntersectionSymbolColor`

  Parameters: | intersectionSymbolColor (Id) –

  New in version NX6.0.0.

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

## IntersectionSymbolFont

`SymbolStyleBuilder.``IntersectionSymbolFont`

  Returns or sets the intersection symbol font

  `-------------------------------------`

  Getter Method

  Signature `IntersectionSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IntersectionSymbolFont`

  Parameters: | intersectionSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## IntersectionSymbolWidth

`SymbolStyleBuilder.``IntersectionSymbolWidth`

  Returns or sets the intersection symbol width

  `-------------------------------------`

  Getter Method

  Signature `IntersectionSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IntersectionSymbolWidth`

  Parameters: | intersectionSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## SurfaceFinishColor

`SymbolStyleBuilder.``SurfaceFinishColor`

  Returns or sets the surface finish symbol color

  `-------------------------------------`

  Getter Method

  Signature `SurfaceFinishColor`

  Returns: |
  Return type: | Id

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SurfaceFinishColor`

  Parameters: | surfaceFinishColor (Id) –

  New in version NX7.5.0.

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

## SurfaceFinishFont

`SymbolStyleBuilder.``SurfaceFinishFont`

  Returns or sets the surface finish symbol font

  `-------------------------------------`

  Getter Method

  Signature `SurfaceFinishFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SurfaceFinishFont`

  Parameters: | surfaceFinishFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX7.5.0.

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

## SurfaceFinishWidth

`SymbolStyleBuilder.``SurfaceFinishWidth`

  Returns or sets the surface finish symbol width

  `-------------------------------------`

  Getter Method

  Signature `SurfaceFinishWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SurfaceFinishWidth`

  Parameters: | surfaceFinishWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX7.5.0.

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

## TargetSymbolColor

`SymbolStyleBuilder.``TargetSymbolColor`

  Returns or sets the target symbol color

  `-------------------------------------`

  Getter Method

  Signature `TargetSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TargetSymbolColor`

  Parameters: | targetSymbolColor (Id) –

  New in version NX6.0.0.

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

## TargetSymbolFont

`SymbolStyleBuilder.``TargetSymbolFont`

  Returns or sets the target symbol font

  `-------------------------------------`

  Getter Method

  Signature `TargetSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TargetSymbolFont`

  Parameters: | targetSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## TargetSymbolWidth

`SymbolStyleBuilder.``TargetSymbolWidth`

  Returns or sets the target symbol width

  `-------------------------------------`

  Getter Method

  Signature `TargetSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TargetSymbolWidth`

  Parameters: | targetSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## UserDefinedSymbolColor

`SymbolStyleBuilder.``UserDefinedSymbolColor`

  Returns or sets the user defined symbol color

  `-------------------------------------`

  Getter Method

  Signature `UserDefinedSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UserDefinedSymbolColor`

  Parameters: | userDefinedSymbolColor (Id) –

  New in version NX6.0.0.

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

## UserDefinedSymbolFont

`SymbolStyleBuilder.``UserDefinedSymbolFont`

  Returns or sets the user defined symbol font

  `-------------------------------------`

  Getter Method

  Signature `UserDefinedSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UserDefinedSymbolFont`

  Parameters: | userDefinedSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## UserDefinedSymbolWidth

`SymbolStyleBuilder.``UserDefinedSymbolWidth`

  Returns or sets the user defined symbol width

  `-------------------------------------`

  Getter Method

  Signature `UserDefinedSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UserDefinedSymbolWidth`

  Parameters: | userDefinedSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

## WeldLineGap

`SymbolStyleBuilder.``WeldLineGap`

  Returns or sets the gap between the weld line and weld type symbol

  `-------------------------------------`

  Getter Method

  Signature `WeldLineGap`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldLineGap`

  Parameters: | gap (float) –

  New in version NX6.0.0.

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

## WeldSpaceFactor

`SymbolStyleBuilder.``WeldSpaceFactor`

  Returns or sets the weld space factor

  `-------------------------------------`

  Getter Method

  Signature `WeldSpaceFactor`

  Returns: |
  Return type: | float

  New in version NX7.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSpaceFactor`

  Parameters: | factor (float) –

  New in version NX6.0.0.

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

## WeldSymbolColor

`SymbolStyleBuilder.``WeldSymbolColor`

  Returns or sets the Weld symbol color

  `-------------------------------------`

  Getter Method

  Signature `WeldSymbolColor`

  Returns: |
  Return type: | Id

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSymbolColor`

  Parameters: | weldSymbolColor (Id) –

  New in version NX6.0.0.

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

## WeldSymbolFont

`SymbolStyleBuilder.``WeldSymbolFont`

  Returns or sets the Weld symbol font

  `-------------------------------------`

  Getter Method

  Signature `WeldSymbolFont`

  Returns: |
  Return type: | `NXOpen.DisplayableObjectObjectFont`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSymbolFont`

  Parameters: | weldSymbolFont (`NXOpen.DisplayableObjectObjectFont`) –

  New in version NX6.0.0.

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

## WeldSymbolSizeFactor

`SymbolStyleBuilder.``WeldSymbolSizeFactor`

  Returns or sets the character size factor that controls the weld symbol size.

  The value is greater than zero.

  `-------------------------------------`

  Getter Method

  Signature `WeldSymbolSizeFactor`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSymbolSizeFactor`

  Parameters: | factor (float) –

  New in version NX8.5.0.

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

## WeldSymbolStandard

`SymbolStyleBuilder.``WeldSymbolStandard`

  Returns or sets the weld symbol standard

  `-------------------------------------`

  Getter Method

  Signature `WeldSymbolStandard`

  Returns: |
  Return type: | `NXOpen.Annotations.WeldStandard`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSymbolStandard`

  Parameters: | standard (`NXOpen.Annotations.WeldStandard`) –

  New in version NX8.5.0.

  License requirements: None.

## WeldSymbolWidth

`SymbolStyleBuilder.``WeldSymbolWidth`

  Returns or sets the Weld symbol width

  `-------------------------------------`

  Getter Method

  Signature `WeldSymbolWidth`

  Returns: |
  Return type: | `NXOpen.Annotations.LineWidth`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `WeldSymbolWidth`

  Parameters: | weldSymbolWidth (`NXOpen.Annotations.LineWidth`) –

  New in version NX6.0.0.

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

# Method Detail

## Validate

`SymbolStyleBuilder.``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.