zsDuplicateHunter Main Window Actions

Top   Previous   Next

The Main Window is the starting point for all scripts.  If you wish to chain scripts together you should ensure that the each script ends at the main dialog so the next script can resume correctly.

 

The Actions for the Main Window will allow you to navigate to other sections of the program.  The Main Window actions also give you access to the functionality found in the File menu and the Help menu.

 

Add Folder To Search

The Add Folder To Search action allows you to add a folder to the list of folders to be searched.

 

Parameter Name

Description

Folder Path

Specifies the full path to the folder you wish to search.

 

Call Script

The Call Script Action will load and run the script specified by the Script File parameter.  When calling scripts, you should try to ensure that the script ends at the Main Window.  Calling Scripts is highly recommended if are planning to create a relatively large script because the Call Script action will allow you to break a larger script into several smaller sections.

 

Parameter Name

Description

Script Path

Specifies the file or directory which should be loaded and run.  You should include the full path to the script.  If a directory is specified, zsDuplicateHunter will load all scripts in the directory and run them all (one at a time).  The scripts are sorted by name, so if order is important for the scripts, you can start the name with 01, 02, 03, etc.

 

Check Action Enabled

The Check Action Enabled action is a basic action which is described in the Basic Actions section of the manual.  You can check if the following actions are enabled Cancel Duplicate Hunt, Collapse All, Delete All Duplicates of File, Delete All Duplicates Except First, Delete All Duplicates Except Newest, Delete All Duplicates Except Oldest, Delete All Files In This Folder Which Have Duplicates, Delete Selected Files, Deselect All Files, Deselect All Files in Group, Expand Children, Find, Ignore Selected, Ignore Selected and Duplicates of Selected, Keep Files In This Folder Delete Duplicates Elsewhere, Open Containing Folder, Open Folders Containing Duplicates, Open in Viewer, Options, Replace Selected and Duplicates of Selected With Links, Replace Duplicates With a Link to selected, Select All Files in Group, Select All Files in Group Except Current, Session 1 , Session 2, Session 3, Session 4, Session 5, Sort Results by Grouping Information, Sort Results by Number of Duplicates, Start Deletion, and Start Duplicate Hunt.

 

Check List Row

The Check List Row action is a basic action which is described in the Basic Actions section of the manual.  You can check the Folders To Search List.

 

Check Property

The Check Property action is a basic action which is described in the Basic Actions section of the manual.  The following properties are available from the zsDuplicateHunter Main Window.

ˇ Duplicate Hunt is Running - This property determines whether or not a duplicate hunt is currently being loaded by the interface.  Valid values are true and false.
ˇ Duplicate Hunt Status - This property returns the current status of the duplicate hunt.  Valid values are Not Started , In Progress , Completed With Errors , and Completed .
ˇ Duplicate Hunt Time - This property returns the elapsed time for the last duplicate hunt.  If no duplicate hunt has been run, or if the current duplicate hunt is in progress, this property will return 0.
ˇ File Sort Mode - Returns the method used to sort duplicate files within the results.  Valid values are By Time Ascending, By Time Descending, and By Name.
ˇ Group Sort Mode - Returns the method used to sort groups when the results are displayed by Group.  Valid values are By Number of Duplicates and By Grouping Information.
ˇ Is Registered - returns whether or not the current program is Registered.  Valid values are true and false.
ˇ Number Duplicate Hunt Options - Returns the number of available options in the Duplicate Hunt Options drop down list.
ˇ Number Folders to Search - Returns the number of folders in the Folders To Search list.
ˇ Number of Bytes Scanned - Returns the number of files that were scanned in the duplicate hunt.
ˇ Number of Duplicates Found - Returns the number of duplicates that were found in the duplicate hunt.
ˇ Number of Files Scanned - Returns the number of files that were scanned in the duplicate hunt.
ˇ Number Result Rows - Returns the number of rows in the Duplicate Hunt Results Table.
ˇ Selected Deletion Method - This property returns the name of the currently selected deletion method in the Deletion Method drop down list.
ˇ Selected Duplicate Hunt Options - This property returns the name of the currently selected options for the Duplicate Hunt.
ˇ Session (1-5) - Returns the full path of the most recently used session in each position.
ˇ View Filter - Returns whether or not Unique files are filtered from the results.  Valid Values are Show Unique Only, Show All Files and Show Duplicates Only .
ˇ View Mode - Returns whether the results are being displayed by Group or by Path as shown in the View menu.  Valid values are By Group and By Path .

 

Check Row Expanded

The Check Row Expanded action will return whether or not the specified row is expanded.  The action will fail if the specified row is not within the range of rows in the table.  You can change whether a row is expanded or collapsed programmatically using the Expand Row action, Collapse All Action, or Expand Children Action.

 

Parameter Name

Description

Row

Specifies which row should be checked.  The first row in the table is row 0.

Expected Value

Specifies whether or not the row is expected to be expanded or not.  The valid values are true and false.

 

Check Table Column Width

This is a basic action which is described in the Basic Actions section of the manual.  You can check widths in the Duplicate Hunt Results table.

 

Check Table Value

This is a basic action which is described in the Basic Actions section of the manual.  You can check values in the Duplicate Hunt Results table.

 

Clear Folders To Search

This action will remove all folders from the list of folders to search.

 

Clear Last Used Sessions

The Clear Last Used Sessions action will remove the most recently used sessions from the File menu.

 

Clear Results

This action will clear the results and reset the status of the duplicate hunt.  It is functionally equivalent to selecting the Clear Results menu item.

 

Collapse All

The Collapse All action will collapse any results which are currently open.  The functionality is equivalent to selecting Collapse All from the results menu.

 

Deselect

The Deselect action will deselect rows based on the selected command.  It is functionally equivalent to selecting the Deselect All Files or the Deselect All Files in Group menu item from the Results menu.

 

Parameter Name

Description

Deselect command

Specifies the actual command to be run.  Valid values are Deselect All Files and Deselect Files in Group.

 

Emulate Edition

The Emulate Edition action will cause the zsDuplicateHunter interface to change to look like another edition of zsDuplicateHunter.  This can be useful if you want to limit yourself to the functionality found in a less powerful version or if you want to produce screenshots which appear to be from another edition of zsDuplicateHunter.

 

Parameter Name

Description

Edition to Emulate

Specifies the edition to be emulated.  Valid values are Standard, Professional, and Enterprise.

 

Expand Children

The Expand Children action will expand the specified row and all of the results which the specified result contains.  It is functionally equivalent to selecting the Expand Children menu item from the Results menu.  The action will fail if the specified row is not within the range of results which are currently displayed.

 

Parameter Name

Description

Row

Specifies which row should be expanded.  The first row in the table is row 0.

 

Expand Row

The Expand Row action will expand or collapse the specified row.  This action is functionally equivalent to expanding or collapsing the result from the results table except that instead of just toggling the row between the expanded and collapsed state, you can explicitly state if the row should be expanded or collapsed.  This action will fail if the specified row is not within the range of results currently being displayed.

 

Parameter Name

Description

Row

Specifies which row should be expanded or collapsed.  The first row in the table is row 0.

New State

Specifies whether or not the row should be expanded or not.  The valid values are Expanded and Collapsed.

 

Export Results to CSV

This action will cause zsDuplicateHunter to export the current results to an CSV file.  This action is functionally equivalent to selecting the Export to CSV File menu item from the File menu.  This action will fail if the specified results file cannot be written to.

 

Parameter Name

Description

File to Save to

Specifies the name of the file which the results should be saved to.  You should include the full path to the result file.

 

Ignore Files

This action allows you to ignore (or remove) files from the results based on what is selected within the results.  This action includes all the different types of ignore commands available within the results menu.  The action will fail if the specified command is not enabled.

 

Parameter Name

Description

Ignore command

Specifies the actual command to be run.  Valid values are Ignore Selected and Ignore Selected and Duplicates of Selected.

 

Load Session

The Load Session action will cause zsDuplicateHunter to load a previously saved session and start the comparison.  The appropriate tab will also be selected based on the type of comparison saved in the session. The load session action is functionally equivalent to selecting Load Session from the File menu.  This action will fail if the specified session cannot be found.

 

Parameter Name

Description

Session Name

Specifies the session file which should be loaded.  You should include the full path to the session.

 

Open File

This action allows you to open files and folders based on what is selected within the results.  This action includes all the different types of open commands available within the results menu.  The action will fail if the specified command is not enabled.

 

Parameter Name

Description

Open command

Specifies the actual command to be run.  Valid values are Open in Viewer, Open Containing Folder, and Open Folders Containing Duplicates.

 

Remove Selected Folders

This action will remove any files which are currently selected in the Folders to Search List.  If no items are selected, no items will be removed.

 

Run Command Line

This action allows you to run a command line from within zsDuplicateHunter.  This can be used on systems where command line options are not easy to use (for example on Mac OS X), or to quickly automate functionality which is supported by the command line interface.  It is not recommended that you use the /script option and the /close option from within a script as they will interfere with the proper operation of the script you are running.  If you run the /clearPrefs command, you must restart the program before all changes take effect.  It is suggested that you include the /noWarnings option so that any warnings will be logged to the results and not shown as warning dialogs.

 

Parameter Name

Description

Command Line

Specifies the command line which will be run by zsDuplicateHunter.  When specifying a path which includes a space in it, you must enclose the path within quotes.

 

Save Results to HTML

The Save Results to HTML action will cause zsDuplicateHunter to save the current results to an HTML file.  This action is functionally equivalent to selecting the Save Results to HTML menu item from the File menu.  This action will fail if the specified results file cannot be written to.  Before the results are saved, you will be presented with an Options Dialog which will need to be filled out.  The file will be written after close the Options Dialog using the OK button.

 

Parameter Name

Description

File to Save to

Specifies the name of the file which the results should be saved to.  You should include the full path to the result file.

 

Save Results to XML

The Save Results to XML action will cause zsDuplicateHunter to save the current results to an XML file.  This action is functionally equivalent to selecting the Save Results to XML menu item from the File menu.  This action will fail if the specified results file cannot be written to.

 

Parameter Name

Description

File to Save to

Specifies the name of the file which the results should be saved to.  You should include the full path to the result file.

 

Save Session

The Save Session action will cause zsDuplicateHunter to save the current comparison settings as a session.  This action is functionally equivalent to selecting the Save Session menu item from the File menu.  This action will fail if the specified session file cannot be written to.

 

Parameter Name

Description

Session Name

Specifies the session file which should be saved.  You should include the full path to the session.

 

Select All

The Select All action will select rows based on the specified command.  It is functionally equivalent to selecting the Select All Files in Group or Select All Files in Group Except Current menu item from the Results menu.

Parameter Name

Description

Select All command

Specifies the actual command to be run.  Valid values are Select All Files in Group and Select All Files in Group Except Current.

 

Select List Row

This is a basic action which is described in the Basic Actions section of the manual.  You can select rows in the Folders To Search list.

 

Select Table Row

This is a basic action which is described in the Basic Actions section of the manual.  You can select rows in the Duplicate Hunt Results table.

 

Set Drop Down List

This is a basic action which is described in the Basic Actions section of the manual.  You can set items in the Duplicate Hunt Options and Deletion Method lists.

 

Set File Sort Mode

This action allows you to change how duplicate files are sorted within the results. Valid values are By Time Ascending, By Time Descending, and By Name.

 

Parameter Name

Description

Sort Mode

Specifies how files should be sorted. Valid values are By Time Ascending, By Time Descending, and By Name.

 

Set Group Sort Mode

This action allows you to change how the groups are sorted within the results when viewing the results By Group.

 

Parameter Name

Description

Sort Mode

Specifies how groups should be sorted.  Valid values are By Number of Duplicates and By Grouping Information.

 

Set View Filter

This action controls whether or not unique files are filtered from the results.  This functionality is the same as the functionality in the View menu.

Parameter Name

Description

View Filter

Specifies how the results should be displayed. Valid values are Show All Files'Show Unique Only, and Show Duplicates Only.

 

Set View Mode

This action controls how the results are displayed.  This is equivalent to changing the View method in the View menu.

 

Parameter Name

Description

View Mode

Specifies how the results should be displayed. Valid values are By Group and By Path.

 

Show Dialog

The Show Dialog action is a basic action which is described in the Basic Actions section of the manual.  The following  dialogs can be shown from the zsDuplicateHunter Main Window.

ˇ About - Equivalent to selecting the About menu item from the Help menu (or zsDuplicateHunter menu on OS X).
ˇ Add Folder to Search Dialog - Equivalent to selecting the Add Folder to Search button using the Custom Explorer.  A file browse dialog will be shown which can be used to select a folder to search by browsing or by using the favorites.
ˇ Adjust Available Memory - Equivalent to selecting the
ˇ Check For Updates - Equivalent to selecting the Check for Updates menu item within the Help menu.
ˇ Enter Registration Key - Equivalent to selecting Enter Registration Key from the Help menu.
ˇ Find - Equivalent to selecting Find from the Results menu.
ˇ Memory Monitor - Equivalent to selecting Memory Monitor from the Help menu.
ˇ Options - Equivalent to selecting the Options menu item from the File menu, or selecting the Edit Options button.
ˇ Tip of the Day - Equivalent to selecting Tips from the Help menu.

 

Start Deletion

This option will start the process of deleting files based on the currently specified deletion method and currently selected files or groups.  The action will fail if the currently specified deletion method is not enabled.

Parameter Name

Description

Wait until Deletion Finishes

Determines whether or not zsDuplicateHunter waits until the deletion has finished until it returns control to the script.  Valid values are yes and no.

Maximum Time to Wait

Specifies the maximum time to wait for the deletion to finish before continuing script execution.

Expected Files to Delete

Optionally specifies the list of files which are expected to be deleted. Files should be separated by semi-colons.

Validate Files to Delete

Determines whether or not zsDuplicateHunter should validate the expected files to delete. Valid values are true and false. If this is set to true and the list of files does not match, no files will be deleted.

Expect Files to be Deleted Permanently

Deter mines whether you expect zsDuplicateHunter to delete the files permanently, or if you expect them to be moved to the deletion folder. Valid values are true and false. If this check fails, no files will be deleted.

Expected Files to Replace with Links

Optionally specifies the list of files which are expected to be replaced with links. Files should be separated by semi-colons.

Validate Files to Replace with Links

Determines whether or not zsDuplicateHunter should validate the expected files to be replaced with links. Valid values are true and false. If this is set to true and the list of files does not match, no files will be deleted.

Expected Files Not Deleted

Optionally specifies the list of files which could not be deleted. Files should be separated by semi-colons.

Validate Files Not Deleted

Determines whether or not zsDuplicateHunter should validate the list of files which could not be deleted. If this is set to true and the list does not match, the action will fail.

 

Start Duplicate Hunt

This action will start the duplicate hunt using the currently specified folders and options.  This action is equivalent to selecting the Start Duplicate Hunt button.  The action will fail if the Start Duplicate Hunt button is not enabled.

Parameter Name

Description

Wait until Duplicate Hunt Finishes

Determines whether or not zsDuplicateHunter waits until the duplicate hunt has finished loading until it returns control to the script.  Valid values are yes and no.

Maximum Time to Wait

Specifies the maximum time to wait for the duplicate hunt to finish before continuing script execution.

 

Basic User Interface Actions

In addition to these actions, you can use the Basic User Interface Actions - Move Dialog, Resize Dialog, and Take Screenshot.  For more information on these actions, see the Basic User Interface Actions section of the manual.