ImportSymbolBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ImportSymbolBuilder Class

class `NXOpen.Annotations.``ImportSymbolBuilder`

  Bases: `NXOpen.Builder`

  Represents a builder allowing import of one or many foreign symbols.

  To create a new instance of this class, use `NXOpen.DraftingManager.CreateImportSymbolBuilder()`

  Default values.

  Property | Value
  --- | ---
  IncludeSubfolders | 0
  PreserveFolderStructure | 0
  SelectMode | File

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
IncludeSubfolders | Returns or sets the subfolders toggle
InputFolder | Returns or sets the name of the input folder
IsPartSymbol | Returns or sets the Is Part Symbol status
IsTeamcenter | Returns or sets the Teamcwenter mode status
LibraryPath | Returns or sets the Reuse library path selection
PreserveFolderStructure | Returns or sets the folder structure toggle
SelectMode | Returns or sets the selection mode
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetExpandedFiles | Returns the names of the expanded files
GetFilesToProcess | Returns the names of the selected files
GetObject | Returns the object currently being edited by this builder.
SetExpandedFiles | Sets the names of the expanded files
SetFilesToProcess | Sets the names of the selected files
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StartImport | Starts the Import process
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ImportSymbolBuilderFileFolder Enumeration | the Selection mode Enum

# Property Detail

## IncludeSubfolders

`ImportSymbolBuilder.``IncludeSubfolders`

  Returns or sets the subfolders toggle

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

  Getter Method

  Signature `IncludeSubfolders`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `IncludeSubfolders`

  Parameters: | includeSubfolders (bool) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## InputFolder

`ImportSymbolBuilder.``InputFolder`

  Returns or sets the name of the input folder

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

  Getter Method

  Signature `InputFolder`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `InputFolder`

  Parameters: | foldername (str) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## IsPartSymbol

`ImportSymbolBuilder.``IsPartSymbol`

  Returns or sets the Is Part Symbol status

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

  Getter Method

  Signature `IsPartSymbol`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `IsPartSymbol`

  Parameters: | isPartSymbol (bool) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## IsTeamcenter

`ImportSymbolBuilder.``IsTeamcenter`

  Returns or sets the Teamcwenter mode status

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

  Getter Method

  Signature `IsTeamcenter`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `IsTeamcenter`

  Parameters: | isTeamcenter (bool) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## LibraryPath

`ImportSymbolBuilder.``LibraryPath`

  Returns or sets the Reuse library path selection

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

  Getter Method

  Signature `LibraryPath`

  Returns: |
  Return type: | str

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `LibraryPath`

  Parameters: | path (str) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## PreserveFolderStructure

`ImportSymbolBuilder.``PreserveFolderStructure`

  Returns or sets the folder structure toggle

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

  Getter Method

  Signature `PreserveFolderStructure`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `PreserveFolderStructure`

  Parameters: | preserveFolderStructure (bool) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## SelectMode

`ImportSymbolBuilder.``SelectMode`

  Returns or sets the selection mode

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

  Getter Method

  Signature `SelectMode`

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

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

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

  Setter Method

  Signature `SelectMode`

  Parameters: | selectMode (`NXOpen.Annotations.ImportSymbolBuilderFileFolder`) –

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

# Method Detail

## GetExpandedFiles

`ImportSymbolBuilder.``GetExpandedFiles`

  Returns the names of the expanded files

  Signature `GetExpandedFiles()`

  Returns: | the list of selected files
  Return type: | list of str

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## GetFilesToProcess

`ImportSymbolBuilder.``GetFilesToProcess`

  Returns the names of the selected files

  Signature `GetFilesToProcess()`

  Returns: | the list of selected files
  Return type: | list of str

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## SetExpandedFiles

`ImportSymbolBuilder.``SetExpandedFiles`

  Sets the names of the expanded files

  Signature `SetExpandedFiles(files)`

  Parameters: | files (list of str) – the list of the selected files

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## SetFilesToProcess

`ImportSymbolBuilder.``SetFilesToProcess`

  Sets the names of the selected files

  Signature `SetFilesToProcess(files)`

  Parameters: | files (list of str) – the list of the selected files

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## StartImport

`ImportSymbolBuilder.``StartImport`

  Starts the Import process

  Signature `StartImport()`

  New in version NX7.5.0.

  License requirements: nx_layout (“NX Layout”)

## Validate

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