NXOpen::Annotations::ImportSymbolBuilder Class Reference

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

Inheritance diagram for NXOpen::Annotations::ImportSymbolBuilder:

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

Public Member Functions
void	GetExpandedFiles (std::vector< NXString > &files)
	Returns the names of the expanded files Created in NX7.5.0. More...
void	GetFilesToProcess (std::vector< NXString > &files)
	Returns the names of the selected files Created in NX7.5.0. More...
bool	IncludeSubfolders ()
	Returns the subfolders toggle Created in NX7.5.0. More...
NXString	InputFolder ()
	Returns the name of the input folder Created in NX7.5.0. More...
bool	IsPartSymbol ()
	Returns the Is Part Symbol status Created in NX7.5.0. More...
bool	IsTeamcenter ()
	Returns the Teamcwenter mode status Created in NX7.5.0. More...
NXString	LibraryPath ()
	Returns the Reuse library path selection Created in NX7.5.0. More...
bool	PreserveFolderStructure ()
	Returns the folder structure toggle Created in NX7.5.0. More...
NXOpen::Annotations::ImportSymbolBuilder::FileFolder	SelectMode ()
	Returns the selection mode Created in NX7.5.0. More...
void	SetExpandedFiles (std::vector< NXString > &files)
	Sets the names of the expanded files Created in NX7.5.0. More...
void	SetFilesToProcess (std::vector< NXString > &files)
	Sets the names of the selected files Created in NX7.5.0. More...
void	SetIncludeSubfolders (bool includeSubfolders)
	Sets the subfolders toggle Created in NX7.5.0. More...
void	SetInputFolder (const NXString &foldername)
	Sets the name of the input folder Created in NX7.5.0. More...
void	SetInputFolder (const char *foldername)
	Sets the name of the input folder Created in NX7.5.0. More...
void	SetLibraryPath (const NXString &path)
	Sets the Reuse library path selection Created in NX7.5.0. More...
void	SetLibraryPath (const char *path)
	Sets the Reuse library path selection Created in NX7.5.0. More...
void	SetPartSymbol (bool isPartSymbol)
	Sets the Is Part Symbol status Created in NX7.5.0. More...
void	SetPreserveFolderStructure (bool preserveFolderStructure)
	Sets the folder structure toggle Created in NX7.5.0. More...
void	SetSelectMode (NXOpen::Annotations::ImportSymbolBuilder::FileFolder selectMode)
	Sets the selection mode Created in NX7.5.0. More...
void	SetTeamcenter (bool isTeamcenter)
	Sets the Teamcwenter mode status Created in NX7.5.0. More...
void	StartImport ()
	Starts the Import process Created in NX7.5.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Annotations::ImportSymbolBuilder::FileFolder

the Selection mode Enum

Enumerator
FileFolderFile	File Selection mode.
FileFolderFolder	Folder Selection mode.

Member Function Documentation

void NXOpen::Annotations::ImportSymbolBuilder::GetExpandedFiles

(

std::vector< NXString > &

files

)

Returns the names of the expanded files
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

files

the list of selected files

void NXOpen::Annotations::ImportSymbolBuilder::GetFilesToProcess

(

std::vector< NXString > &

files

)

Returns the names of the selected files
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

files

the list of selected files

bool NXOpen::Annotations::ImportSymbolBuilder::IncludeSubfolders

(

)

Returns the subfolders toggle
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

NXString NXOpen::Annotations::ImportSymbolBuilder::InputFolder

(

)

Returns the name of the input folder
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

bool NXOpen::Annotations::ImportSymbolBuilder::IsPartSymbol

(

)

Returns the Is Part Symbol status
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

bool NXOpen::Annotations::ImportSymbolBuilder::IsTeamcenter

(

)

Returns the Teamcwenter mode status
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

NXString NXOpen::Annotations::ImportSymbolBuilder::LibraryPath

(

)

Returns the Reuse library path selection
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

bool NXOpen::Annotations::ImportSymbolBuilder::PreserveFolderStructure

(

)

Returns the folder structure toggle
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

NXOpen::Annotations::ImportSymbolBuilder::FileFolder NXOpen::Annotations::ImportSymbolBuilder::SelectMode

(

)

Returns the selection mode
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

void NXOpen::Annotations::ImportSymbolBuilder::SetExpandedFiles

(

std::vector< NXString > &

files

)

Sets the names of the expanded files
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

files

the list of the selected files

void NXOpen::Annotations::ImportSymbolBuilder::SetFilesToProcess

(

std::vector< NXString > &

files

)

Sets the names of the selected files
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

files

the list of the selected files

void NXOpen::Annotations::ImportSymbolBuilder::SetIncludeSubfolders

(

bool

includeSubfolders

)

Sets the subfolders toggle
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

includeSubfolders

includesubfolders

void NXOpen::Annotations::ImportSymbolBuilder::SetInputFolder

(

const NXString &

foldername

)

Sets the name of the input folder
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

foldername

foldername

void NXOpen::Annotations::ImportSymbolBuilder::SetInputFolder

(

const char *

foldername

)

Sets the name of the input folder
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

foldername

foldername

void NXOpen::Annotations::ImportSymbolBuilder::SetLibraryPath

(

const NXString &

path

)

Sets the Reuse library path selection
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

path

path

void NXOpen::Annotations::ImportSymbolBuilder::SetLibraryPath

(

const char *

path

)

Sets the Reuse library path selection
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

path

path

void NXOpen::Annotations::ImportSymbolBuilder::SetPartSymbol

(

bool

isPartSymbol

)

Sets the Is Part Symbol status
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

isPartSymbol

ispartsymbol

void NXOpen::Annotations::ImportSymbolBuilder::SetPreserveFolderStructure

(

bool

preserveFolderStructure

)

Sets the folder structure toggle
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

preserveFolderStructure

preservefolderstructure

void NXOpen::Annotations::ImportSymbolBuilder::SetSelectMode

(

NXOpen::Annotations::ImportSymbolBuilder::FileFolder

selectMode

)

Sets the selection mode
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

selectMode

selectmode

void NXOpen::Annotations::ImportSymbolBuilder::SetTeamcenter

(

bool

isTeamcenter

)

Sets the Teamcwenter mode status
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

Parameters

isTeamcenter

isteamcenter

void NXOpen::Annotations::ImportSymbolBuilder::StartImport

(

)

Starts the Import process
Created in NX7.5.0.

License requirements : nx_layout ("NX Layout")

---

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

• Annotations_ImportSymbolBuilder.hxx