CommandImporter Class — NXOpen Python API Reference 12.0.0 documentation

# CommandImporter Class

class `NXOpen.Report.``CommandImporter`

  Bases: `NXOpen.TransientObject`

  Represents a command importer to import the commands into command libary.

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ImportOption | Returns or sets the command override option.

# Methods

Method | Description
--- | ---
Dispose | Destroys the object
GetImportCandidates | Gets all candidate commands in library file.
ImportCommands | Imports the selected commands into command library.

# Enumerations

CommandImporterOverrideOption Enumeration | Represents the override option when there is already a command existing.

# Property Detail

## ImportOption

`CommandImporter.``ImportOption`

  Returns or sets the command override option.

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

  Getter Method

  Signature `ImportOption`

  Returns: |
  Return type: | `NXOpen.Report.CommandImporterOverrideOption`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ImportOption`

  Parameters: | importOption (`NXOpen.Report.CommandImporterOverrideOption`) –

  New in version NX11.0.0.

  License requirements: None.

# Method Detail

## Dispose

`CommandImporter.``Dispose`

  Destroys the object

  Signature `Dispose()`

  New in version NX11.0.0.

  License requirements: None.

## GetImportCandidates

`CommandImporter.``GetImportCandidates`

  Gets all candidate commands in library file.

  Signature `GetImportCandidates()`

  Returns: |
  Return type: | list of `NXOpen.Report.Command`

  New in version NX11.0.0.

  License requirements: None.

## ImportCommands

`CommandImporter.``ImportCommands`

  Imports the selected commands into command library.

  Signature `ImportCommands(pCommandIndexes)`

  Parameters: | pCommandIndexes (list of int) –

  New in version NX11.0.0.

  License requirements: None.