SymbolPreferences Class — NXOpen Python API Reference 12.0.0 documentation

# SymbolPreferences Class

class `NXOpen.Annotations.``SymbolPreferences`

  Bases: `NXOpen.TransientObject`

  Represents symbol preferences

  New in version NX3.0.0.

# Properties

Property | Description
--- | ---
DraftingSurfaceFinishStandard | Returns or sets the drafting surface finish standard
IdSymbolSize | Returns or sets the id symbol size
WeldSymbolStandard | Returns or sets the weld symbol standard

# Methods

Method | Description
--- | ---
Dispose | Frees the object from memory.
GetCenterlineSymbolCfw | Returns the centerline symbol color, font, and width
GetGdtSymbolCfw | Returns the gdt symbol color, font, and width
GetIdSymbolCfw | Returns the id symbol color, font, and width
GetIntersectionSymbolCfw | Returns the intersection symbol color, font, and width
GetSurfaceFinishCfw | Returns the surface finish symbol color, font, and width
GetTargetSymbolCfw | Returns the target symbol color, font, and width
GetUserDefinedSymbolCfw | Returns the user defined symbol color, font, and width
GetWeldLineGap | Returns the weld line gap
GetWeldSpaceFactor | Returns the weld space factor
GetWeldSymbolCfw | Returns the weld symbol color, font, and width
GetWeldSymbolSizeFactor | The character size factor that controls the weld symbol size.
SetCenterlineSymbolCfw | Sets the centerline symbol color, font, and width
SetGdtSymbolCfw | Sets the gdt symbol color, font, and width
SetIdSymbolCfw | Sets the id symbol color, font, and width
SetIntersectionSymbolCfw | Sets the intersection symbol color, font, and width
SetSurfaceFinishCfw | Sets the surface finish symbol color, font, and width
SetTargetSymbolCfw | Sets the target symbol color, font, and width
SetUserDefinedSymbolCfw | Sets the user defined symbol color, font, and width
SetWeldLineGap | Sets the weld symbol line gap
SetWeldSpaceFactor | Sets the weld symbol space factor
SetWeldSymbolCfw | Sets the weld symbol color, font, and width
SetWeldSymbolSizeFactor |

# Property Detail

## DraftingSurfaceFinishStandard

`SymbolPreferences.``DraftingSurfaceFinishStandard`

  Returns or sets the drafting surface finish 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: None.

## IdSymbolSize

`SymbolPreferences.``IdSymbolSize`

  Returns or sets the id symbol size

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

  Getter Method

  Signature `IdSymbolSize`

  Returns: |
  Return type: | float

  New in version NX3.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IdSymbolSize`

  Parameters: | idSymbolSize (float) –

  New in version NX3.0.0.

  License requirements: None.

## WeldSymbolStandard

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

# Method Detail

## Dispose

`SymbolPreferences.``Dispose`

  Frees the object from memory.

  After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

  Signature `Dispose()`

  New in version NX3.0.0.

  License requirements: None.

## GetCenterlineSymbolCfw

`SymbolPreferences.``GetCenterlineSymbolCfw`

  Returns the centerline symbol color, font, and width

  Signature `GetCenterlineSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetGdtSymbolCfw

`SymbolPreferences.``GetGdtSymbolCfw`

  Returns the gdt symbol color, font, and width

  Signature `GetGdtSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetIdSymbolCfw

`SymbolPreferences.``GetIdSymbolCfw`

  Returns the id symbol color, font, and width

  Signature `GetIdSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetIntersectionSymbolCfw

`SymbolPreferences.``GetIntersectionSymbolCfw`

  Returns the intersection symbol color, font, and width

  Signature `GetIntersectionSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetSurfaceFinishCfw

`SymbolPreferences.``GetSurfaceFinishCfw`

  Returns the surface finish symbol color, font, and width

  Signature `GetSurfaceFinishCfw()`

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

  New in version NX7.5.0.

  License requirements: None.

## GetTargetSymbolCfw

`SymbolPreferences.``GetTargetSymbolCfw`

  Returns the target symbol color, font, and width

  Signature `GetTargetSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetUserDefinedSymbolCfw

`SymbolPreferences.``GetUserDefinedSymbolCfw`

  Returns the user defined symbol color, font, and width

  Signature `GetUserDefinedSymbolCfw()`

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

  New in version NX3.0.0.

  License requirements: None.

## GetWeldLineGap

`SymbolPreferences.``GetWeldLineGap`

  Returns the weld line gap

  Signature `GetWeldLineGap()`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

## GetWeldSpaceFactor

`SymbolPreferences.``GetWeldSpaceFactor`

  Returns the weld space factor

  Signature `GetWeldSpaceFactor()`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: None.

## GetWeldSymbolCfw

`SymbolPreferences.``GetWeldSymbolCfw`

  Returns the weld symbol color, font, and width

  Signature `GetWeldSymbolCfw()`

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

  New in version NX6.0.0.

  License requirements: None.

## GetWeldSymbolSizeFactor

`SymbolPreferences.``GetWeldSymbolSizeFactor`

  The character size factor that controls the weld symbol size.

  The value is greater than zero.

  Signature `GetWeldSymbolSizeFactor()`

  Returns: |
  Return type: | float

  New in version NX8.5.0.

  License requirements: None.

## SetCenterlineSymbolCfw

`SymbolPreferences.``SetCenterlineSymbolCfw`

  Sets the centerline symbol color, font, and width

  Signature `SetCenterlineSymbolCfw(centerlineSymbolCfw)`

  Parameters: | centerlineSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetGdtSymbolCfw

`SymbolPreferences.``SetGdtSymbolCfw`

  Sets the gdt symbol color, font, and width

  Signature `SetGdtSymbolCfw(gdtSymbolCfw)`

  Parameters: | gdtSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetIdSymbolCfw

`SymbolPreferences.``SetIdSymbolCfw`

  Sets the id symbol color, font, and width

  Signature `SetIdSymbolCfw(idSymbolCfw)`

  Parameters: | idSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetIntersectionSymbolCfw

`SymbolPreferences.``SetIntersectionSymbolCfw`

  Sets the intersection symbol color, font, and width

  Signature `SetIntersectionSymbolCfw(intersectionSymbolCfw)`

  Parameters: | intersectionSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetSurfaceFinishCfw

`SymbolPreferences.``SetSurfaceFinishCfw`

  Sets the surface finish symbol color, font, and width

  Signature `SetSurfaceFinishCfw(surfaceFinishCfw)`

  Parameters: | surfaceFinishCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX7.5.0.

  License requirements: None.

## SetTargetSymbolCfw

`SymbolPreferences.``SetTargetSymbolCfw`

  Sets the target symbol color, font, and width

  Signature `SetTargetSymbolCfw(targetSymbolCfw)`

  Parameters: | targetSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetUserDefinedSymbolCfw

`SymbolPreferences.``SetUserDefinedSymbolCfw`

  Sets the user defined symbol color, font, and width

  Signature `SetUserDefinedSymbolCfw(userDefinedSymbolCfw)`

  Parameters: | userDefinedSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX3.0.0.

  License requirements: None.

## SetWeldLineGap

`SymbolPreferences.``SetWeldLineGap`

  Sets the weld symbol line gap

  Signature `SetWeldLineGap(lineGap)`

  Parameters: | lineGap (float) –

  New in version NX6.0.0.

  License requirements: None.

## SetWeldSpaceFactor

`SymbolPreferences.``SetWeldSpaceFactor`

  Sets the weld symbol space factor

  Signature `SetWeldSpaceFactor(spaceFactor)`

  Parameters: | spaceFactor (float) –

  New in version NX6.0.0.

  License requirements: None.

## SetWeldSymbolCfw

`SymbolPreferences.``SetWeldSymbolCfw`

  Sets the weld symbol color, font, and width

  Signature `SetWeldSymbolCfw(weldSymbolCfw)`

  Parameters: | weldSymbolCfw (`NXOpen.Annotations.LineCfw`) –

  New in version NX6.0.0.

  License requirements: None.

## SetWeldSymbolSizeFactor

`SymbolPreferences.``SetWeldSymbolSizeFactor`

  Signature `SetWeldSymbolSizeFactor(symbolSizeFactor)`

  Parameters: | symbolSizeFactor (float) –

  New in version NX8.5.0.

  License requirements: None.