CustomSymbolCollection Class — NXOpen Python API Reference 12.0.0 documentation

# CustomSymbolCollection Class

class `NXOpen.Annotations.``CustomSymbolCollection`

  Bases: `object`

  Represents a collection of `NXOpen.Annotations.BaseCustomSymbol` objects

  To obtain an instance of this class, refer to `NXOpen.Annotations.AnnotationManager`

  New in version NX4.0.0.

# Methods

Method | Description
--- | ---
CreateCustomSymbol | Creates a custom symbol
CreateDraftingCustomSymbolBuilder | Creates the Drafting Symbol placement builder
CreateMasterSymbolBuilder | Creates the Master Symbol builder
CreateMasterSymbolListItemBuilder | Creates the Master Symbol List Item builder
CreatePmiCustomSymbol | Creates a PMI custom symbol
CreatePmiCustomSymbolBuilder | Creates the PMI Symbol Placement builder
CreateReplaceSymbolBuilder | Creates a `NXOpen.Annotations.ReplaceSymbolBuilder`
CreateSmashCustomSymbolBuilder | Smashes a custom symbol
CreateSymbolCatalogBuilder | Creates a symbol catalog dialog builder
EditSymbolDisplayBuilder | Creates a edit custom symbol dialog builder
FindObject | Finds the `NXOpen.Annotations.MasterSymbol` with the given name.
NewCustomSymbolData | Creates new CustomSymbolData object
NewPartSymbolData | Creates new CustomSymbolData object to create a part symbol instance.

# Method Detail

## CreateCustomSymbol

`CustomSymbolCollection.``CreateCustomSymbol`

  Creates a custom symbol

  Signature `CreateCustomSymbol(customSymbolData, origin, leader)`

  Parameters:

  - customSymbolData (`NXOpen.Annotations.CustomSymbolData`) –
  - origin (`NXOpen.Point3d`) – Origin for the custom symbol
  - leader (`NXOpen.Annotations.LeaderBundle`) – Specifies the leaders for the custom symbol

  Returns: | New custom symbol
  Return type: | `NXOpen.Annotations.CustomSymbol`

  New in version NX4.0.0.

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

  License requirements: drafting (“DRAFTING”)

## CreateDraftingCustomSymbolBuilder

`CustomSymbolCollection.``CreateDraftingCustomSymbolBuilder`

  Creates the Drafting Symbol placement builder

  Signature `CreateDraftingCustomSymbolBuilder(symbolTag)`

  Parameters: | symbolTag (`NXOpen.Annotations.CustomSymbol`) – Symbol as input
  Returns: | DraftingCustomSymbolBuilder object
  Return type: | `NXOpen.Annotations.DraftingCustomSymbolBuilder`

  New in version NX7.5.0.

  License requirements: None.

## CreateMasterSymbolBuilder

`CustomSymbolCollection.``CreateMasterSymbolBuilder`

  Creates the Master Symbol builder

  Signature `CreateMasterSymbolBuilder(masterSymbolTag)`

  Parameters: | masterSymbolTag (`NXOpen.Annotations.MasterSymbol`) – `NXOpen.Annotations.MasterSymbol` to be set as master symbol
  Returns: | MasterSymbolBuilder object
  Return type: | `NXOpen.Annotations.MasterSymbolBuilder`

  New in version NX7.5.0.

  License requirements: None.

## CreateMasterSymbolListItemBuilder

`CustomSymbolCollection.``CreateMasterSymbolListItemBuilder`

  Creates the Master Symbol List Item builder

  Signature `CreateMasterSymbolListItemBuilder()`

  Returns: | CustomSymbolListItemBuilder object
  Return type: | `NXOpen.Annotations.MasterSymbolListItemBuilder`

  New in version NX7.5.0.

  License requirements: None.

## CreatePmiCustomSymbol

`CustomSymbolCollection.``CreatePmiCustomSymbol`

  Creates a PMI custom symbol

  Signature `CreatePmiCustomSymbol(customSymbolData, pmiData, annotationPlane, origin, leader)`

  Parameters:

  - customSymbolData (`NXOpen.Annotations.CustomSymbolData`) –
  - pmiData (`NXOpen.Annotations.PmiData`) – PMI data
  - annotationPlane (`NXOpen.Xform`) – Annotation plane on which the custom symbol lies
  - origin (`NXOpen.Point3d`) – Origin for the custom symbol
  - leader (`NXOpen.Annotations.LeaderBundle`) – Specifies the leaders for the custom symbol

  Returns: | New PMI custom symbol
  Return type: | `NXOpen.Annotations.PmiCustomSymbol`

  New in version NX4.0.0.

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

  License requirements: geometric_tol (“GDT”)

## CreatePmiCustomSymbolBuilder

`CustomSymbolCollection.``CreatePmiCustomSymbolBuilder`

  Creates the PMI Symbol Placement builder

  Signature `CreatePmiCustomSymbolBuilder(symbolTag)`

  Parameters: | symbolTag (`NXOpen.Annotations.PmiCustomSymbol`) – Symbol as input
  Returns: | PMICustomSymbolBuilder object
  Return type: | `NXOpen.Annotations.PmiCustomSymbolBuilder`

  New in version NX7.5.0.

  License requirements: None.

## CreateReplaceSymbolBuilder

`CustomSymbolCollection.``CreateReplaceSymbolBuilder`

  Creates a `NXOpen.Annotations.ReplaceSymbolBuilder`

  Signature `CreateReplaceSymbolBuilder()`

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

  New in version NX8.0.1.

  License requirements: drafting (“DRAFTING”)

## CreateSmashCustomSymbolBuilder

`CustomSymbolCollection.``CreateSmashCustomSymbolBuilder`

  Smashes a custom symbol

  Signature `CreateSmashCustomSymbolBuilder()`

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

  New in version NX6.0.0.

  License requirements: None.

## CreateSymbolCatalogBuilder

`CustomSymbolCollection.``CreateSymbolCatalogBuilder`

  Creates a symbol catalog dialog builder

  Signature `CreateSymbolCatalogBuilder()`

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

  New in version NX8.0.0.

  License requirements: nx_layout (“NX Layout”)

## EditSymbolDisplayBuilder

`CustomSymbolCollection.``EditSymbolDisplayBuilder`

  Creates a edit custom symbol dialog builder

  Signature `EditSymbolDisplayBuilder(symbolTag)`

  Parameters: | symbolTag (`NXOpen.Annotations.BaseCustomSymbol`) – Symbol as input
  Returns: |
  Return type: | `NXOpen.Annotations.EditSymbolDisplayBuilder`

  New in version NX7.5.0.

  License requirements: None.

## FindObject

`CustomSymbolCollection.``FindObject`

  Finds the `NXOpen.Annotations.MasterSymbol` with the given name.

  An exception will be thrown if no object can be found with the given name.

  Signature `FindObject(name)`

  Parameters: | name (str) – Master custom symbol name
  Returns: | Master custom symbol object
  Return type: | `NXOpen.Annotations.MasterSymbol`

  New in version NX7.5.0.

  License requirements: None.

## NewCustomSymbolData

`CustomSymbolCollection.``NewCustomSymbolData`

  Creates new CustomSymbolData object

  Signature `NewCustomSymbolData(masterFileName)`

  Parameters: | masterFileName (str) – Absolute path of the master symbol(with .sym.prt extension)
  Returns: | New CustomSymbolData
  Return type: | `NXOpen.Annotations.CustomSymbolData`

  New in version NX4.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.Annotations.DraftingCustomSymbolBuilder` for Drafting Custom Symbol and `NXOpen.Annotations.PmiCustomSymbolBuilder` for PMI Custom Symbol objects.

  License requirements: None.

## NewPartSymbolData

`CustomSymbolCollection.``NewPartSymbolData`

  Creates new CustomSymbolData object to create a part symbol instance.

  Signature `NewPartSymbolData(partSymbolName)`

  Parameters: | partSymbolName (str) – Part symbol name. Part symbol is a master symbol that is created and instantiated in the same part.
  Returns: | New CustomSymbolData
  Return type: | `NXOpen.Annotations.CustomSymbolData`

  New in version NX4.0.0.

  Deprecated since version NX9.0.0: Use `NXOpen.Annotations.DraftingCustomSymbolBuilder` for Drafting Custom Symbol and `NXOpen.Annotations.PmiCustomSymbolBuilder` for PMI Custom Symbol objects.

  License requirements: None.