UnusedFileManagementBuilder Class

class NXOpen.Tooling.UnusedFileManagementBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Tooling.UnusedFileManagementBuilder Unused File Management is to manage the unused files of the project.

To create a new instance of this class, use NXOpen.Tooling.UnusedFileManagementCollection.CreateUnusedFileManagementBuilder()

Default values.

Property Value
ListDir ProjectDirectory
SelectAll 0

New in version NX8.0.0.

Properties

Property Description
ListDir Returns or sets the listed directory.
SelectAll Returns or sets the select all option.
Tag Returns the Tag for this object.

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

UnusedFileManagementBuilderFileDirectory Enumeration the unused file location.

Property Detail

ListDir

UnusedFileManagementBuilder.ListDir

Returns or sets the listed directory.

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

Getter Method

Signature ListDir()

Returns:
Return type:NXOpen.Tooling.UnusedFileManagementBuilderFileDirectory

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ListDir(listDir)

Parameters:listDir (NXOpen.Tooling.UnusedFileManagementBuilderFileDirectory) –

New in version NX8.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

SelectAll

UnusedFileManagementBuilder.SelectAll

Returns or sets the select all option.

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

Getter Method

Signature SelectAll()

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SelectAll(selectAll)

Parameters:selectAll (bool) –

New in version NX8.0.0.

License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)

Method Detail

Validate

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