MasterCustomSymbolData Class — NXOpen Python API Reference 12.0.0 documentation

# MasterCustomSymbolData Class

class `NXOpen.Annotations.``MasterCustomSymbolData`

  Bases: `NXOpen.TransientObject`

  Represents master custom symbol data

  New in version NX6.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.Annotations.MasterSymbolBuilder` instead.

# Properties

Property | Description
--- | ---
Anchor | Returns or sets the anchor point
PartName | Returns or sets the master part name
SymbolName | Returns or sets the symbol name

# Methods

Method | Description
--- | ---
Dispose | Frees the object from memory.
GetPath | Get the path for part name
SetGeometry | Specify the geometry for this master custom symbol data.
SetPath | Set the valid path for part name

# Property Detail

## Anchor

`MasterCustomSymbolData.``Anchor`

  Returns or sets the anchor point

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

  Getter Method

  Signature `Anchor`

  Returns: | Anchor point
  Return type: | `NXOpen.Point`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Anchor`

  Parameters: | anchor (`NXOpen.Point`) – New anchor point

  New in version NX6.0.0.

  License requirements: None.

## PartName

`MasterCustomSymbolData.``PartName`

  Returns or sets the master part name

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

  Getter Method

  Signature `PartName`

  Returns: | The master part name
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PartName`

  Parameters: | name (str) – New master part name

  New in version NX6.0.0.

  License requirements: None.

## SymbolName

`MasterCustomSymbolData.``SymbolName`

  Returns or sets the symbol name

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

  Getter Method

  Signature `SymbolName`

  Returns: | Symbol name
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SymbolName`

  Parameters: | name (str) – New symbol name

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Dispose

`MasterCustomSymbolData.``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 NX6.0.0.

  License requirements: None.

## GetPath

`MasterCustomSymbolData.``GetPath`

  Get the path for part name

  Signature `GetPath()`

  Returns: | Path
  Return type: | str

  New in version NX7.5.2.

  License requirements: None.

## SetGeometry

`MasterCustomSymbolData.``SetGeometry`

  Specify the geometry for this master custom symbol data.

  Signature `SetGeometry(geom)`

  Parameters: | geom (list of `NXOpen.DisplayableObject`) – symbol geometry

  New in version NX6.0.0.

  License requirements: None.

## SetPath

`MasterCustomSymbolData.``SetPath`

  Set the valid path for part name

  Signature `SetPath(path)`

  Parameters: | path (str) – New path

  New in version NX7.5.2.

  License requirements: None.