ImportAutocadBlockBuilder Class

class NXOpen.Annotations.ImportAutocadBlockBuilder

Bases: NXOpen.Builder

Represents a builder allowing import of AutoCAD blocks.

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

Default values.

Property Value
IncludeSubfolders 0
PreserveFolderStructure 0
SelectMode File

New in version NX8.0.0.

Properties

Property Description
ImportEntityType Returns or sets the Import Entity type.
ImportPolylineTo Returns or sets the Import polyline option
IncludeModelSpace Returns or sets the model space toggle
IncludeSubfolders Returns or sets the subfolders toggle
InputFolder Returns or sets the name of the input folder
LibraryPathName Returns or sets the Reuse library path name.
PreserveFolderStructure Returns or sets the folder structure toggle
SelectMode Returns or sets the selection mode
SettingsFile Returns or sets the AutoCAD setting file
SymbolType Returns or sets the Symbol type.
Tag Returns the Tag for this object.
Unit Returns or sets the symbol part unit

Methods

Method Description
AddFile Adds a file to import list
AddFolder Adds a folder to import list
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.
GetObject Returns the object currently being edited by this builder.
RemoveFile Removes a file from import list
RemoveFolder Removes a folder from import list
SelectBlock Selects or deselects a block.
SelectFile Selects or deselects a file
SelectFolder Selects or deselects a folder
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

ImportAutocadBlockBuilderEntityType Enumeration Represents the Import Entity Type.
ImportAutocadBlockBuilderFileFolder Enumeration the Selection mode Enum
ImportAutocadBlockBuilderType Enumeration Symbol Type Enum.

Property Detail

ImportEntityType

ImportAutocadBlockBuilder.ImportEntityType

Returns or sets the Import Entity type.

-------------------------------------

Getter Method

Signature ImportEntityType

Returns:
Return type:NXOpen.Annotations.ImportAutocadBlockBuilderEntityType

New in version NX11.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature ImportEntityType

Parameters:entityType (NXOpen.Annotations.ImportAutocadBlockBuilderEntityType) –

New in version NX11.0.0.

License requirements: nx_layout (“NX Layout”)

ImportPolylineTo

ImportAutocadBlockBuilder.ImportPolylineTo

Returns or sets the Import polyline option

-------------------------------------

Getter Method

Signature ImportPolylineTo

Returns:
Return type:int

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature ImportPolylineTo

Parameters:type (int) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

IncludeModelSpace

ImportAutocadBlockBuilder.IncludeModelSpace

Returns or sets the model space toggle

-------------------------------------

Getter Method

Signature IncludeModelSpace

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature IncludeModelSpace

Parameters:includeModelSpace (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

IncludeSubfolders

ImportAutocadBlockBuilder.IncludeSubfolders

Returns or sets the subfolders toggle

-------------------------------------

Getter Method

Signature IncludeSubfolders

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature IncludeSubfolders

Parameters:includeSubfolders (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

InputFolder

ImportAutocadBlockBuilder.InputFolder

Returns or sets the name of the input folder

-------------------------------------

Getter Method

Signature InputFolder

Returns:
Return type:str

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature InputFolder

Parameters:foldername (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

LibraryPathName

ImportAutocadBlockBuilder.LibraryPathName

Returns or sets the Reuse library path name.

-------------------------------------

Getter Method

Signature LibraryPathName

Returns:
Return type:str

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature LibraryPathName

Parameters:pathName (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

PreserveFolderStructure

ImportAutocadBlockBuilder.PreserveFolderStructure

Returns or sets the folder structure toggle

-------------------------------------

Getter Method

Signature PreserveFolderStructure

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature PreserveFolderStructure

Parameters:preserveFolderStructure (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SelectMode

ImportAutocadBlockBuilder.SelectMode

Returns or sets the selection mode

-------------------------------------

Getter Method

Signature SelectMode

Returns:
Return type:NXOpen.Annotations.ImportAutocadBlockBuilderFileFolder

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature SelectMode

Parameters:selectMode (NXOpen.Annotations.ImportAutocadBlockBuilderFileFolder) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SettingsFile

ImportAutocadBlockBuilder.SettingsFile

Returns or sets the AutoCAD setting file

-------------------------------------

Getter Method

Signature SettingsFile

Returns:
Return type:str

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature SettingsFile

Parameters:settingsFile (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SymbolType

ImportAutocadBlockBuilder.SymbolType

Returns or sets the Symbol type.

Used to differentiate native, teamcenter and part folder modes

-------------------------------------

Getter Method

Signature SymbolType

Returns:
Return type:NXOpen.Annotations.ImportAutocadBlockBuilderType

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature SymbolType

Parameters:symbolType (NXOpen.Annotations.ImportAutocadBlockBuilderType) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

Unit

ImportAutocadBlockBuilder.Unit

Returns or sets the symbol part unit

-------------------------------------

Getter Method

Signature Unit

Returns:
Return type:int

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

-------------------------------------

Setter Method

Signature Unit

Parameters:unit (int) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

Method Detail

AddFile

ImportAutocadBlockBuilder.AddFile

Adds a file to import list

Signature AddFile(fileName)

Parameters:fileName (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

AddFolder

ImportAutocadBlockBuilder.AddFolder

Adds a folder to import list

Signature AddFolder(folderName)

Parameters:folderName (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

RemoveFile

ImportAutocadBlockBuilder.RemoveFile

Removes a file from import list

Signature RemoveFile(fileName)

Parameters:fileName (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

RemoveFolder

ImportAutocadBlockBuilder.RemoveFolder

Removes a folder from import list

Signature RemoveFolder(folderName)

Parameters:folderName (str) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SelectBlock

ImportAutocadBlockBuilder.SelectBlock

Selects or deselects a block.

Both file and block names need to be specified

Signature SelectBlock(fileName, blockName, isSelected)

Parameters:
  • fileName (str) –
  • blockName (str) –
  • isSelected (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SelectFile

ImportAutocadBlockBuilder.SelectFile

Selects or deselects a file

Signature SelectFile(fileName, isSelected)

Parameters:
  • fileName (str) –
  • isSelected (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

SelectFolder

ImportAutocadBlockBuilder.SelectFolder

Selects or deselects a folder

Signature SelectFolder(folderName, isSelected)

Parameters:
  • folderName (str) –
  • isSelected (bool) –

New in version NX8.0.0.

License requirements: nx_layout (“NX Layout”)

Validate

ImportAutocadBlockBuilder.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.