Basic User Interface Actions

Top   Previous   Next

These actions will occur on several dialogs.  The dialogs which they appear on will depend on the design of the dialog and the controls which are available on the dialog.  Each action will be explained further on the dialog where it occurs.

 

Change Focus

The Change Focus Action will change focus between sections of a dialog.  For example, on the main screen of zsDuplicateHunter, there are three tabs, the Directories tab, Files tab, and Freeform Text tab.  You can use the Change Focus Action to switch between each tab.  In some cases, you will see the special section of previous which will allow you to move to the last section used.  For example, after you set the focus to the Directory comparison tab, you will need to call Change Focus with Set Focus to set to Previous in order to return to the zsDuplicateHunter Main Window.  The available sections which you can transfer focus to will be defined in the section of the help manual defining the screen.

 

Parameter Name

Description

Set Focus To

The Set Focus To parameter allows you to determine what section to transfer focus to.  The list of available sections will be pre-filled for you.   You cannot use variables when specifying this parameter.

 

Check Action Enabled

The Check Action Enabled action will check if a specified menu item or button is currently enabled.

 

Parameter Name

Description

Control

Specifies the name of the control to check.  The list of valid controls will be provided and will depend on the screen which is active.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: equal to, not equal, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

Valid values are true and false.

Variable To Set

Optionally specifies a variable to set.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be created.

 

Check List Row

The Check List Row action allows you to check the contents of a specific row in a list box.  The action will fail if the specified row is not valid or if the actual value does not match the expected value.

 

Parameter Name

Description

List

Specifies the list which should be checked.  The list of valid lists will be provided and will depend on the screen which is active.

Row

Specifies the Row which should be checked

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: less than, less than or equal, equal to, greater than or equal, greater than, not equal, equal ignore case, start with, ends with, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Check Property

The Check Property action will appear on most but not all screens.  This action allows you to check the value of something on the specified target.  For example, on the Directory Comparison Tab, you can check to see if a comparison is still loading or determine what the currently selected file is.  In most cases, you will want to handle the failure of the check using a separate action.  The available properties for each screen will be defined in the section of the help manual defining the screen with the type of expected values you can expect.

 

When checking the paths of a file, the path separators will be automatically corrected.  This will assist you in creating cross platform scripts because you will not need to create a separate script due to changes in the file separator between Windows, OS X, and Linux.

 

Parameter Name

Description

Property

The Property parameter determines which property you want to check.  The list of available properties will be pre-filled for you to select from.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: less than, less than or equal, equal to, greater than or equal, greater than, not equal, equal ignore case, starts with, ends with, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Check Table Column Width

This action allows you to check the width of a column within a table.  The action will fail if the column specified is not valid or if the actual value does not match the expected value.

Parameter Name

Description

Table

Specifies the table which should be checked.  The list of valid tables will be provided and will depend on the screen which is active.

Column

Specifies the Column which should be checked.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: less than, less than or equal, equal to, greater than or equal, greater than, not equal, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Check Table Value

The Check Table Value action allows you to check the value of a cell within a table. The action will fail if the row and column are not valid or if the actual value does not match the expected value.

 

Parameter Name

Description

Table

Specifies the table which should be checked.  The list of valid tables will be provided and will depend on the screen which is active.

Row

Specifies the Row which should be checked.

Column

Specifies the Column which should be checked.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: less than, less than or equal, equal to, greater than or equal, greater than, not equal, equal ignore case, starts with, ends with, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Check Tree Node Expanded

The Check Tree Node Expanded action allows you to check whether or not the specified row of a tree is currently expanded.  The action will fail if the specified row is not valid, or if the actual value does not match the expected value.

 

Parameter Name

Description

Tree

Specifies the tree which should be checked.  The list of valid trees will be provided and will depend on the screen which is active.

Row

Specifies the Row which should be checked.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: equal to, not equal, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.  Valid values are true and false.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Check Tree Node Value

The Check Tree Node Value action allows you to check the value of a row in a tree.  The action will fail if the specified row is not valid, or if the actual value does not match the expected value.

 

Parameter Name

Description

Tree

Specifies the tree which should be checked.  The list of valid trees will be provided and will depend on the screen which is active.

Row

Specifies the Row which should be checked.

Operation

The operation determines how you want to compare the expected value to the actual value.  The available comparison types are: less than, less than or equal, equal to, greater than or equal, greater than, not equal, equal ignore case, and no check.  The no check operation is useful when you just want to set a variable.

Expected Value

The expected value tells zsDuplicateHunter what value you are expecting the property to hold.  Valid values are true and false.

Variable To Set

Optionally specifies a variable to set with the value of the table cell.  If the Variable To Set is not provided, it will be ignored.  If the Variable To Set cannot be found, it will be noted, but the action will not fail.

 

Close Dialog

The Close Dialog action will cause the script to close the active dialog and return to the previous screen.  If the dialog to be closed has OK and Cancel buttons, there will be a parameter asking if you would like to close the dialog with the OK button or the Cancel button.  If the dialog only contains a Close button, the parameter will not be shown.

 

Parameter Name

Description

Close Using

Specifies whether the dialog should be closed using the OK button or the Cancel button.  This parameter will not be visible if the Dialog contains a Close button instead of OK and Cancel buttons.  Valid values are OK and Cancel.

 

Enter Text

The Enter Text action will enter text into a text area. The name of the text area will be added after the action name.

 

Parameter Name

Description

New Text

Specifies the new value for the text area.

Expand Escape Characters

Determines whether or not escape sequences should be converted.  To enter a carriage return specify \r in the text.  To enter a line feed, specify \n in the text.  To enter a tab, specify \t in the text.

 

Expand Tree Node

The Expand Tree Node action will expand or collapse the specified row.  The action will fail if the specified row is not valid.

 

Parameter Name

Description

Tree

Specifies the tree which should be checked.  The list of valid trees will be provided and will depend on the screen which is active.

Row

Specifies the Row which should be checked.  You can also specify current to expand or collapse the currently selected row.

Action

Specifies whether the row should be expanded or collapsed.  Valid values are expand and collapse.

 

Move Dialog

The Move Dialog action will move the current dialog dialog from the current location on the screen to the specified location.  The Move Dialog action will be available whenever the current target is a dialog.

 

Parameter Name

Description

X Position

The X Position specifies the horizontal location of the upper left corner of the dialog.  0 is the left side of the screen.  The X Position should be an integer greater than or equal to 0.  It is specified in Pixels.

Y Position

The Y Position specifies the vertical location of the upper left corner of the dialog.  0 is the top of the screen.  The Y Position should be an integer greater than or equal to 0.  It is specified in Pixels.

 

Resize Dialog

The Resize Dialog action will resize the current dialog to the new specified size.  This action will fail if the current dialog is not resizeable.

 

Parameter Name

Description

Width

The Width specifies the horizontal size of the dialog.  The Width should be an integer greater than  0. It is specified in Pixels.

Height

The Height specifies the vertical size of the dialog.  The Height should be an integer greater than or equal to 0.  It is specified in Pixels.

 

Select List Row

The Select List Row action allows you to select one or more entries within the specified list box.  The action will fail if the specified row is not within the applicable range of the list.

 

Parameter Name

Description

List

Specifies the name of the list which should be used for selection.  The list of available lists will be provided.

Start Row

Specifies the first row which should be selected.  The first row in the list is row 0.

End Row

Specifies the last row which should be selected.  The first row in the list is row 0.  To select only one row, the End Row should be set to the same value as the Start Row.

Add to Current Selection

Determines whether or not the current selection should be cleared before selecting the new row or rows.  Valid values are yes and no.

 

Select Tab

The Select Tab action allows you to change the currently selected tab on the specified tab control.

 

Parameter Name

Description

Tab to Set

Specifies which tab should be changed.  The list of available tab controls will be provided.

New Tab

Specifies whether the name of the tab to which you would like to change.  The tab to switch to may be specified either by name or by index.  The first tab in a set is index 0.  Tab names are case-sensitive.

 

Select Table Cell

The Select Table Cell action will allow you to select a specified cell within a table.  The action will fail if the specified row or column is not within the range of available rows and columns.  If you select a cell which is already selected, the cell will be de-selected if the Add to Current Selection parameter is set to yes.  If the Add to Current Selection parameter is set to no, all other selections will be cleared and the specified cell will remain selected.

 

Parameter Name

Description

Table

Specifies which table the cell should be selected in.  The list of available tables will be provided.

Row

Specifies the row which should be selected.

Column

Specifies the column which should be selected.

Add to Current Selection

Determines whether or not the current selection should be cleared before selecting the new cell.  Valid values are yes and no.

 

Select Table Row

The Select Table Row action will allow you to select a specified row within a table.  The action will fail if the specified row is not within the range of available rows.

 

Parameter Name

Description

Table

Specifies which table the cell should be selected in.  The list of available tables will be provided.

Start Row

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

End Row

Specifies the last row which should be selected.  The first row in the table is row 0.  To select only one row, the End Row should be set to the same value as the Start Row.

Add to Current Selection

Determines whether or not the current selection should be cleared before selecting the new row or rows.  Valid values are yes and no.

 

Select Item In Tree

The Select Item In Tree action allows you to select a specific item within a tree.  To specify the item, you must specify the row which you would like to select.  The action will fail if the specified row is not valid.

 

Parameter Name

Description

Tree

Specifies which tree which the selection should occur in.  The list of available tree controls will be provided.

Row

Specifies the full path to the item you wish to select.

Add to Current Selection

Determines whether or not the current selection should be cleared before selecting the new row.  Valid values are yes and no.

 

Set Checkbox

The Set Checkbox action will turn a checkbox on or off depending on the new value you specify.

 

Parameter Name

Description

Checkbox to Set

Specifies which checkbox should be set.

New Value

Specifies whether the checkbox should be checked on or off.  The valid values are true and false.  Specifying true for the New Value will turn the checkbox on.

 

Set Drop Down List

The Set Drop Down List action will select a new value within a drop down list. The action will fail if the specified value cannot be found in the drop down list.  The name of the list will be added after the action name.

 

Parameter Name

Description

New Value

Specifies the new value for the drop down list.  If zsDuplicateHunter can determine the valid values, they will be shown in a list.  Otherwise, you will need to review the contents of the list to determine the valid values.

 

Set Option Group

The Set Option Group action allows you to select from a set of options which are shown as option buttons.  The name of the option set will be after the action name.

 

Parameter Name

Description

New Value

Specifies the new value to select for the set of options.  The list of valid options will be provided for you.

 

Set Table Cell Value

The Set Table Cell Value action will allow you to select a change the contents of a cell within a table.  The action will fail if the specified row or column is not within the range of available rows and columns.  The action will also fail if the specified cell cannot be changed.

 

Parameter Name

Description

Table

Specifies which table the cell should be selected in.  The list of available tables will be provided.

Row

Specifies the row of the cell to change.

Column

Specifies the column of the cell to change.

New Value

Specifies the new value which should be entered.

 

Show Dialog

The Show Dialog action will open a new dialog based on the type specified.  This action will fail if the dialog cannot be opened.  The available dialogs which can be opened will be defined in the section of the help manual defining the screen actions.

 

Parameter Name

Description

Dialog to Open

Specifies the dialog which should be opened.  The list of available dialogs will be pre-filled for you to select from.

 

Take Screenshot

The Take Screenshot action will take a picture of the current screen or section of a screen and save it to the specified file.  The format used will depend on the format specified.  This action will fail if the file specified cannot be written to.

 

Parameter Name

Description

Filename

Specifies the file to save the screenshot to.  The filename should include the full path to the file.

Format

Specifies the format of the screenshot.  The list of formats will be system dependent.

Create Thumbnail

Determines whether or not zsDuplicateHunter will create a smaller version (thumbnail) of the screenshot.  The thumbnail will be located in the same directory specified by Filename, and will have the word -Thumb appended after the name of the filename.

Max Thumbnail Size

Specifies the maximum width or height of the thumbnail.  The thumbnail will be scaled to fit within the maximum size.  The size should be an integer greater than or equal to 1.  It is specified in Pixels.