Represents a builder allowing import of AutoCAD blocks. More...

Inheritance diagram for NXOpen::Annotations::ImportAutocadBlockBuilder:

Public Types
enum	FileFolder { FileFolderFile, FileFolderFolder }
	the Selection mode Enum More...

enum	Type { TypeTeamcenter, TypePart, TypeNative }
	Symbol Type Enum. More...

Public Member Functions
void	AddFile (const NXString &fileName)
	Adds a file to import list Created in NX8.0.0.

void	AddFile (const char *fileName)
	Adds a file to import list Created in NX8.0.0.

void	AddFolder (const NXString &folderName)
	Adds a folder to import list Created in NX8.0.0.

void	AddFolder (const char *folderName)
	Adds a folder to import list Created in NX8.0.0.

int	ImportPolylineTo ()
	Returns the Import polyline option Created in NX8.0.0.

bool	IncludeModelSpace ()
	Returns the model space toggle Created in NX8.0.0.

bool	IncludeSubfolders ()
	Returns the subfolders toggle Created in NX8.0.0.

NXString	InputFolder ()
	Returns the name of the input folder Created in NX8.0.0.

NXString	LibraryPathName ()
	Returns the Reuse library path name.

bool	PreserveFolderStructure ()
	Returns the folder structure toggle Created in NX8.0.0.

void	RemoveFile (const NXString &fileName)
	Removes a file from import list Created in NX8.0.0.

void	RemoveFile (const char *fileName)
	Removes a file from import list Created in NX8.0.0.

void	RemoveFolder (const NXString &folderName)
	Removes a folder from import list Created in NX8.0.0.

void	RemoveFolder (const char *folderName)
	Removes a folder from import list Created in NX8.0.0.

void	SelectBlock (const NXString &fileName, const NXString &blockName, bool isSelected)
	Selects or deselects a block.

void	SelectBlock (const char fileName, const char blockName, bool isSelected)
	Selects or deselects a block.

void	SelectFile (const NXString &fileName, bool isSelected)
	Selects or deselects a file Created in NX8.0.0.

void	SelectFile (const char *fileName, bool isSelected)
	Selects or deselects a file Created in NX8.0.0.

void	SelectFolder (const NXString &folderName, bool isSelected)
	Selects or deselects a folder Created in NX8.0.0.

void	SelectFolder (const char *folderName, bool isSelected)
	Selects or deselects a folder Created in NX8.0.0.

NXOpen::Annotations::ImportAutocadBlockBuilder::FileFolder	SelectMode ()
	Returns the selection mode Created in NX8.0.0.

void	SetImportPolylineTo (int type)
	Sets the Import polyline option Created in NX8.0.0.

void	SetIncludeModelSpace (bool includeModelSpace)
	Sets the model space toggle Created in NX8.0.0.

void	SetIncludeSubfolders (bool includeSubfolders)
	Sets the subfolders toggle Created in NX8.0.0.

void	SetInputFolder (const NXString &foldername)
	Sets the name of the input folder Created in NX8.0.0.

void	SetInputFolder (const char *foldername)
	Sets the name of the input folder Created in NX8.0.0.

void	SetLibraryPathName (const NXString &pathName)
	Sets the Reuse library path name.

void	SetLibraryPathName (const char *pathName)
	Sets the Reuse library path name.

void	SetPreserveFolderStructure (bool preserveFolderStructure)
	Sets the folder structure toggle Created in NX8.0.0.

void	SetSelectMode (NXOpen::Annotations::ImportAutocadBlockBuilder::FileFolder selectMode)
	Sets the selection mode Created in NX8.0.0.

void	SetSettingsFile (const NXString &settingsFile)
	Sets the AutoCAD setting file Created in NX8.0.0.

void	SetSettingsFile (const char *settingsFile)
	Sets the AutoCAD setting file Created in NX8.0.0.

void	SetSymbolType (NXOpen::Annotations::ImportAutocadBlockBuilder::Type symbolType)
	Sets the Symbol type.

NXString	SettingsFile ()
	Returns the AutoCAD setting file Created in NX8.0.0.

void	SetUnit (int unit)
	Sets the symbol part unit Created in NX8.0.0.

NXOpen::Annotations::ImportAutocadBlockBuilder::Type	SymbolType ()
	Returns the Symbol type.

int	Unit ()
	Returns the symbol part unit Created in NX8.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a builder allowing import of AutoCAD blocks.

 <br> To create a new instance of this class, use @link DraftingManager::CreateImportAutocadBlockBuilder  DraftingManager::CreateImportAutocadBlockBuilder @endlink  <br>

Default values.

Property

Value

IncludeSubfolders

0

PreserveFolderStructure

0

SelectMode

File

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::ImportAutocadBlockBuilder::FileFolder

the Selection mode Enum

Enumerator:

FileFolderFile	File Selection mode.
FileFolderFolder	Folder Selection mode.

enum NXOpen::Annotations::ImportAutocadBlockBuilder::Type

Symbol Type Enum.

This option is used to differentiate OS, Teamcenter and Part symbols

Enumerator:

TypeTeamcenter	Teamcenter Symbol.
TypePart	Part Symbol.
TypeNative	OS Symbol.

Member Function Documentation

void NXOpen::Annotations::ImportAutocadBlockBuilder::AddFile ( const NXString & fileName )

Adds a file to import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::AddFile ( const char * fileName )

Adds a file to import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::AddFolder ( const NXString & folderName )

Adds a folder to import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::AddFolder ( const char * folderName )

Adds a folder to import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName NOTE: The full Unicode character set is not supported for this parameter.

int NXOpen::Annotations::ImportAutocadBlockBuilder::ImportPolylineTo ( )

Returns the Import polyline option
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

bool NXOpen::Annotations::ImportAutocadBlockBuilder::IncludeModelSpace ( )

Returns the model space toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

bool NXOpen::Annotations::ImportAutocadBlockBuilder::IncludeSubfolders ( )

Returns the subfolders toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXString NXOpen::Annotations::ImportAutocadBlockBuilder::InputFolder ( )

Returns the name of the input folder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

NXString NXOpen::Annotations::ImportAutocadBlockBuilder::LibraryPathName ( )

Returns the Reuse library path name.

Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

bool NXOpen::Annotations::ImportAutocadBlockBuilder::PreserveFolderStructure ( )

Returns the folder structure toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

void NXOpen::Annotations::ImportAutocadBlockBuilder::RemoveFile ( const NXString & fileName )

Removes a file from import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::RemoveFile ( const char * fileName )

Removes a file from import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::RemoveFolder ( const NXString & folderName )

Removes a folder from import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::RemoveFolder ( const char * folderName )

Removes a folder from import list
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectBlock	(	const NXString &	fileName,
		const NXString &	blockName,
		bool	isSelected
	)

Selects or deselects a block.

Both file and block names need to be specified
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName	NOTE: The full Unicode character set is not supported for this parameter.
blockName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectBlock	(	const char *	fileName,
		const char *	blockName,
		bool	isSelected
	)

Selects or deselects a block.

Both file and block names need to be specified
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName	NOTE: The full Unicode character set is not supported for this parameter.
blockName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectFile	(	const NXString &	fileName,
		bool	isSelected
	)

Selects or deselects a file
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectFile	(	const char *	fileName,
		bool	isSelected
	)

Selects or deselects a file
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

fileName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectFolder	(	const NXString &	folderName,
		bool	isSelected
	)

Selects or deselects a folder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

void NXOpen::Annotations::ImportAutocadBlockBuilder::SelectFolder	(	const char *	folderName,
		bool	isSelected
	)

Selects or deselects a folder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

folderName	NOTE: The full Unicode character set is not supported for this parameter.
isSelected	isselected

NXOpen::Annotations::ImportAutocadBlockBuilder::FileFolder NXOpen::Annotations::ImportAutocadBlockBuilder::SelectMode ( )

Returns the selection mode
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetImportPolylineTo ( int type )

Sets the Import polyline option
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

type type

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetIncludeModelSpace ( bool includeModelSpace )

Sets the model space toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

includeModelSpace includemodelspace

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetIncludeSubfolders ( bool includeSubfolders )

Sets the subfolders toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

includeSubfolders includesubfolders

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetInputFolder ( const NXString & foldername )

Sets the name of the input folder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

foldername foldername

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetInputFolder ( const char * foldername )

Sets the name of the input folder
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

foldername foldername

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetLibraryPathName ( const NXString & pathName )

Sets the Reuse library path name.

Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

pathName pathname

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetLibraryPathName ( const char * pathName )

Sets the Reuse library path name.

Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

pathName pathname

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetPreserveFolderStructure ( bool preserveFolderStructure )

Sets the folder structure toggle
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

preserveFolderStructure preservefolderstructure

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetSelectMode ( NXOpen::Annotations::ImportAutocadBlockBuilder::FileFolder selectMode )

Sets the selection mode
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

selectMode selectmode

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetSettingsFile ( const NXString & settingsFile )

Sets the AutoCAD setting file
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

settingsFile settingsfile

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetSettingsFile ( const char * settingsFile )

Sets the AutoCAD setting file
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

settingsFile settingsfile

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetSymbolType ( NXOpen::Annotations::ImportAutocadBlockBuilder::Type symbolType )

Sets the Symbol type.

Used to differentiate native, teamcenter and part folder modes
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

symbolType symboltype

NXString NXOpen::Annotations::ImportAutocadBlockBuilder::SettingsFile ( )

Returns the AutoCAD setting file
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

void NXOpen::Annotations::ImportAutocadBlockBuilder::SetUnit ( int unit )

Sets the symbol part unit
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

Parameters

unit unit

NXOpen::Annotations::ImportAutocadBlockBuilder::Type NXOpen::Annotations::ImportAutocadBlockBuilder::SymbolType ( )

Returns the Symbol type.

Used to differentiate native, teamcenter and part folder modes
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

int NXOpen::Annotations::ImportAutocadBlockBuilder::Unit ( )

Returns the symbol part unit
Created in NX8.0.0.

License requirements : nx_drafting_plus ("DraftingPlus")

The documentation for this class was generated from the following file:

Annotations_ImportAutocadBlockBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation