RenameAndExportComponentBuilder Class¶
-
class
NXOpen.Tooling.
RenameAndExportComponentBuilder
¶ Bases:
NXOpen.Builder
Creates rename and export component builder for progressive die.
No entity is returned. To create a new instance of this class, use
NXOpen.Tooling.ProgressiveDieManager.CreateRenameAndExportComponentBuilder()
Default values.
Property Value DefineBy Selection DeleteOldComponentsToggle 0 ExportDrawingFile 0 ListChildrenComponents 0 LoadOption FromFolder NewNameRule None ToolingNameRule Default New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
AddFolderToSearch | Returns or sets the add folder to search |
DefineBy | Returns or sets the define by |
DeleteOldComponentsToggle | Returns or sets the delete old components toggle |
ExportDrawingFile | Returns or sets the export drawing file |
ListChildrenComponents | Returns or sets the list children components |
LoadOption | Returns or sets the load option |
NeedChangeDisplayPartBack | Returns or sets the need change display part back toggle |
NewNameRule | Returns or sets the new name rule |
NewStringInName | Returns or sets the new string in name |
NextPartNameNumber | Returns or sets the next part name number |
OldStringInName | Returns or sets the old string in name |
OutputDiretory | Returns or sets the output diretory |
PartDirectory | Returns or sets the part directory |
PrefixOrSuffixString | Returns or sets the prefix or suffix string |
SelectAssemblyInFolder | Returns or sets the select assembly in folder |
SelectAssemblyToExport | Returns the select assembly to export |
SelectComponentToRename | Returns the select component to rename |
Tag | Returns the Tag for this object. |
ToolingNameRule | Returns or sets the tooling name rule |
Type | Returns or sets the type |
WizardType | Returns or sets the wizard type |
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. |
ExportComponents | Export components |
ExportSingleComponent | Export single component |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetDrawingFilesInFolder | Export components |
GetObject | Returns the object currently being edited by this builder. |
RenameComponents | Rename components |
ReplaceComponent | Replace components |
SetSearchFolderListForExportDrawingFiles | Set search folder list |
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¶
RenameAndExportComponentBuilderDefinitionType Enumeration | definition type |
RenameAndExportComponentBuilderLoadOptionType Enumeration | load option type |
RenameAndExportComponentBuilderNameRuleType Enumeration | tooling naming rule |
RenameAndExportComponentBuilderNamingRuleType Enumeration | naming rule |
RenameAndExportComponentBuilderTypes Enumeration | types |
Property Detail¶
AddFolderToSearch¶
-
RenameAndExportComponentBuilder.
AddFolderToSearch
¶ Returns or sets the add folder to search
-------------------------------------
Getter Method
Signature
AddFolderToSearch
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AddFolderToSearch
Parameters: foldername (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
DefineBy¶
-
RenameAndExportComponentBuilder.
DefineBy
¶ Returns or sets the define by
-------------------------------------
Getter Method
Signature
DefineBy
Returns: Return type: NXOpen.Tooling.RenameAndExportComponentBuilderDefinitionType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DefineBy
Parameters: defineBy ( NXOpen.Tooling.RenameAndExportComponentBuilderDefinitionType
) –New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
DeleteOldComponentsToggle¶
-
RenameAndExportComponentBuilder.
DeleteOldComponentsToggle
¶ Returns or sets the delete old components toggle
-------------------------------------
Getter Method
Signature
DeleteOldComponentsToggle
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DeleteOldComponentsToggle
Parameters: deleteOldComponentsToggle (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ExportDrawingFile¶
-
RenameAndExportComponentBuilder.
ExportDrawingFile
¶ Returns or sets the export drawing file
-------------------------------------
Getter Method
Signature
ExportDrawingFile
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExportDrawingFile
Parameters: exportDrawingFile (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ListChildrenComponents¶
-
RenameAndExportComponentBuilder.
ListChildrenComponents
¶ Returns or sets the list children components
-------------------------------------
Getter Method
Signature
ListChildrenComponents
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ListChildrenComponents
Parameters: listChildrenComponents (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
LoadOption¶
-
RenameAndExportComponentBuilder.
LoadOption
¶ Returns or sets the load option
-------------------------------------
Getter Method
Signature
LoadOption
Returns: Return type: NXOpen.Tooling.RenameAndExportComponentBuilderLoadOptionType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LoadOption
Parameters: loadOption ( NXOpen.Tooling.RenameAndExportComponentBuilderLoadOptionType
) –New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
NeedChangeDisplayPartBack¶
-
RenameAndExportComponentBuilder.
NeedChangeDisplayPartBack
¶ Returns or sets the need change display part back toggle
-------------------------------------
Getter Method
Signature
NeedChangeDisplayPartBack
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedChangeDisplayPartBack
Parameters: needChangeDisplayPartBack (bool) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
NewNameRule¶
-
RenameAndExportComponentBuilder.
NewNameRule
¶ Returns or sets the new name rule
-------------------------------------
Getter Method
Signature
NewNameRule
Returns: Return type: NXOpen.Tooling.RenameAndExportComponentBuilderNamingRuleType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewNameRule
Parameters: newNameRule ( NXOpen.Tooling.RenameAndExportComponentBuilderNamingRuleType
) –New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
NewStringInName¶
-
RenameAndExportComponentBuilder.
NewStringInName
¶ Returns or sets the new string in name
-------------------------------------
Getter Method
Signature
NewStringInName
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewStringInName
Parameters: newStringInName (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OldStringInName¶
-
RenameAndExportComponentBuilder.
OldStringInName
¶ Returns or sets the old string in name
-------------------------------------
Getter Method
Signature
OldStringInName
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OldStringInName
Parameters: oldStringInName (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OutputDiretory¶
-
RenameAndExportComponentBuilder.
OutputDiretory
¶ Returns or sets the output diretory
-------------------------------------
Getter Method
Signature
OutputDiretory
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputDiretory
Parameters: foldername (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
PartDirectory¶
-
RenameAndExportComponentBuilder.
PartDirectory
¶ Returns or sets the part directory
-------------------------------------
Getter Method
Signature
PartDirectory
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PartDirectory
Parameters: partDirectory (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
PrefixOrSuffixString¶
-
RenameAndExportComponentBuilder.
PrefixOrSuffixString
¶ Returns or sets the prefix or suffix string
-------------------------------------
Getter Method
Signature
PrefixOrSuffixString
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PrefixOrSuffixString
Parameters: prefixOrSuffixString (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SelectAssemblyInFolder¶
-
RenameAndExportComponentBuilder.
SelectAssemblyInFolder
¶ Returns or sets the select assembly in folder
-------------------------------------
Getter Method
Signature
SelectAssemblyInFolder
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectAssemblyInFolder
Parameters: foldername (str) – New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SelectAssemblyToExport¶
-
RenameAndExportComponentBuilder.
SelectAssemblyToExport
¶ Returns the select assembly to export
-------------------------------------
Getter Method
Signature
SelectAssemblyToExport
Returns: Return type: NXOpen.SelectNXObject
New in version NX11.0.0.
License requirements: None.
SelectComponentToRename¶
-
RenameAndExportComponentBuilder.
SelectComponentToRename
¶ Returns the select component to rename
-------------------------------------
Getter Method
Signature
SelectComponentToRename
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX11.0.0.
License requirements: None.
ToolingNameRule¶
-
RenameAndExportComponentBuilder.
ToolingNameRule
¶ Returns or sets the tooling name rule
-------------------------------------
Getter Method
Signature
ToolingNameRule
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolingNameRule
Parameters: toolingNameRule (str) – New in version NX12.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Type¶
-
RenameAndExportComponentBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Tooling.RenameAndExportComponentBuilderTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Tooling.RenameAndExportComponentBuilderTypes
) –New in version NX11.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
WizardType¶
-
RenameAndExportComponentBuilder.
WizardType
¶ Returns or sets the wizard type
-------------------------------------
Getter Method
Signature
WizardType
Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WizardType
Parameters: wizardType (int) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
ExportComponents¶
-
RenameAndExportComponentBuilder.
ExportComponents
¶ Export components
Signature
ExportComponents(partTag, assemblyInFolderWithPath, outputDir)
Parameters: - partTag (
NXOpen.NXObject
) – - assemblyInFolderWithPath (str) –
- outputDir (str) –
New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- partTag (
ExportSingleComponent¶
-
RenameAndExportComponentBuilder.
ExportSingleComponent
¶ Export single component
Signature
ExportSingleComponent(assemblyPartNameWithPath, outputDir)
Parameters: - assemblyPartNameWithPath (str) –
- outputDir (str) –
New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
GetDrawingFilesInFolder¶
-
RenameAndExportComponentBuilder.
GetDrawingFilesInFolder
¶ Export components
Signature
GetDrawingFilesInFolder(assemblyPartToExport, assemblyInFolderWithPath, outputDir, onlyGetDrawingFilesNotExport)
Parameters: - assemblyPartToExport (
NXOpen.NXObject
) – - assemblyInFolderWithPath (str) –
- outputDir (str) –
- onlyGetDrawingFilesNotExport (bool) –
Returns: Return type: list of str
New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- assemblyPartToExport (
RenameComponents¶
-
RenameAndExportComponentBuilder.
RenameComponents
¶ Rename components
Signature
RenameComponents(partTag, dirName, newPartName)
Parameters: - partTag (
NXOpen.NXObject
) – - dirName (str) –
- newPartName (str) –
New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- partTag (
ReplaceComponent¶
-
RenameAndExportComponentBuilder.
ReplaceComponent
¶ Replace components
Signature
ReplaceComponent(componentTag, newComponentNameWithPath)
Parameters: - componentTag (
NXOpen.NXObject
) – - newComponentNameWithPath (str) –
New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- componentTag (
SetSearchFolderListForExportDrawingFiles¶
-
RenameAndExportComponentBuilder.
SetSearchFolderListForExportDrawingFiles
¶ Set search folder list
Signature
SetSearchFolderListForExportDrawingFiles(folderList)
Parameters: folderList (list of str) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Validate¶
-
RenameAndExportComponentBuilder.
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.