NX Open C++ Reference Guide
|
Represents a builder allowing import of one or many foreign symbols. More...
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. | |
void | GetFilesToProcess (std::vector< NXString > &files) |
Returns the names of the selected files Created in NX7.5.0. | |
bool | IncludeSubfolders () |
Returns the subfolders toggle Created in NX7.5.0. | |
NXString | InputFolder () |
Returns the name of the input folder Created in NX7.5.0. | |
bool | IsPartSymbol () |
Returns the Is Part Symbol status Created in NX7.5.0. | |
bool | IsTeamcenter () |
Returns the Teamcwenter mode status Created in NX7.5.0. | |
NXString | LibraryPath () |
Returns the Reuse library path selection Created in NX7.5.0. | |
bool | PreserveFolderStructure () |
Returns the folder structure toggle Created in NX7.5.0. | |
NXOpen::Annotations::ImportSymbolBuilder::FileFolder | SelectMode () |
Returns the selection mode Created in NX7.5.0. | |
void | SetExpandedFiles (std::vector< NXString > &files) |
Sets the names of the expanded files Created in NX7.5.0. | |
void | SetFilesToProcess (std::vector< NXString > &files) |
Sets the names of the selected files Created in NX7.5.0. | |
void | SetIncludeSubfolders (bool includeSubfolders) |
Sets the subfolders toggle Created in NX7.5.0. | |
void | SetInputFolder (const NXString &foldername) |
Sets the name of the input folder Created in NX7.5.0. | |
void | SetInputFolder (const char *foldername) |
Sets the name of the input folder Created in NX7.5.0. | |
void | SetLibraryPath (const NXString &path) |
Sets the Reuse library path selection Created in NX7.5.0. | |
void | SetLibraryPath (const char *path) |
Sets the Reuse library path selection Created in NX7.5.0. | |
void | SetPartSymbol (bool isPartSymbol) |
Sets the Is Part Symbol status Created in NX7.5.0. | |
void | SetPreserveFolderStructure (bool preserveFolderStructure) |
Sets the folder structure toggle Created in NX7.5.0. | |
void | SetSelectMode (NXOpen::Annotations::ImportSymbolBuilder::FileFolder selectMode) |
Sets the selection mode Created in NX7.5.0. | |
void | SetTeamcenter (bool isTeamcenter) |
Sets the Teamcwenter mode status Created in NX7.5.0. | |
void | StartImport () |
Starts the Import process Created in NX7.5.0. | |
![]() | |
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. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
Represents a builder allowing import of one or many foreign symbols.
<br> To create a new instance of this class, use @link DraftingManager::CreateImportSymbolBuilder DraftingManager::CreateImportSymbolBuilder @endlink <br>
Default values.
Property | Value |
---|---|
IncludeSubfolders |
0 |
PreserveFolderStructure |
0 |
SelectMode |
File |
Created in NX7.5.0.
void NXOpen::Annotations::ImportSymbolBuilder::GetExpandedFiles | ( | std::vector< NXString > & | files | ) |
Returns the names of the expanded files
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
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_drafting_plus ("DraftingPlus")
files | the list of selected files |
bool NXOpen::Annotations::ImportSymbolBuilder::IncludeSubfolders | ( | ) |
Returns the subfolders toggle
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
NXString NXOpen::Annotations::ImportSymbolBuilder::InputFolder | ( | ) |
Returns the name of the input folder
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
bool NXOpen::Annotations::ImportSymbolBuilder::IsPartSymbol | ( | ) |
Returns the Is Part Symbol status
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
bool NXOpen::Annotations::ImportSymbolBuilder::IsTeamcenter | ( | ) |
Returns the Teamcwenter mode status
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
NXString NXOpen::Annotations::ImportSymbolBuilder::LibraryPath | ( | ) |
Returns the Reuse library path selection
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
bool NXOpen::Annotations::ImportSymbolBuilder::PreserveFolderStructure | ( | ) |
Returns the folder structure toggle
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
NXOpen::Annotations::ImportSymbolBuilder::FileFolder NXOpen::Annotations::ImportSymbolBuilder::SelectMode | ( | ) |
Returns the selection mode
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
void NXOpen::Annotations::ImportSymbolBuilder::SetExpandedFiles | ( | std::vector< NXString > & | files | ) |
Sets the names of the expanded files
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
files | the list of the selected files NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Annotations::ImportSymbolBuilder::SetFilesToProcess | ( | std::vector< NXString > & | files | ) |
Sets the names of the selected files
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
files | the list of the selected files NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Annotations::ImportSymbolBuilder::SetIncludeSubfolders | ( | bool | includeSubfolders | ) |
Sets the subfolders toggle
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
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_drafting_plus ("DraftingPlus")
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_drafting_plus ("DraftingPlus")
foldername | foldername |
void NXOpen::Annotations::ImportSymbolBuilder::SetLibraryPath | ( | const NXString & | path | ) |
Sets the Reuse library path selection
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
path | path |
void NXOpen::Annotations::ImportSymbolBuilder::SetLibraryPath | ( | const char * | path | ) |
Sets the Reuse library path selection
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
path | path |
void NXOpen::Annotations::ImportSymbolBuilder::SetPartSymbol | ( | bool | isPartSymbol | ) |
Sets the Is Part Symbol status
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
isPartSymbol | ispartsymbol |
void NXOpen::Annotations::ImportSymbolBuilder::SetPreserveFolderStructure | ( | bool | preserveFolderStructure | ) |
Sets the folder structure toggle
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
preserveFolderStructure | preservefolderstructure |
void NXOpen::Annotations::ImportSymbolBuilder::SetSelectMode | ( | NXOpen::Annotations::ImportSymbolBuilder::FileFolder | selectMode | ) |
Sets the selection mode
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
selectMode | selectmode |
void NXOpen::Annotations::ImportSymbolBuilder::SetTeamcenter | ( | bool | isTeamcenter | ) |
Sets the Teamcwenter mode status
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")
isTeamcenter | isteamcenter |
void NXOpen::Annotations::ImportSymbolBuilder::StartImport | ( | ) |
Starts the Import process
Created in NX7.5.0.
License requirements : nx_drafting_plus ("DraftingPlus")