Goto: Driver Commands, Component Functions, Engine Commands, Detailed Reference Doc
DDDriverCommands [How To Read This Reference]
AppMapChaining |
|
Enable and Disable support for App Map chaining. | |||
AppMapResolve |
|
Enable and Disable support for embedded DDVariables in App Map strings. | |||
AssignClipboardVariable |
|
Copy the clipboard contents to a DDVariable. | |||
CallRemote |
|
Execute a command on an external system / application. | |||
CaptureMousePositionOnScreen |
|
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables. | |||
ClearAllVariables |
|
Clear storage of all DDVariables. | |||
ClearAppMapCache |
|
Clear the internal application map cache. | |||
ClearArrayVariables |
|
Clear storage of all SAFS variables containing a specific prefix. | |||
ClearClipboard |
|
Clear the contents of the Window's clipboard. | |||
CloseApplication |
|
Close a named application process launched with LaunchApplication. | |||
CloseApplicationMap |
|
By map ID, Close a opened Application Map in map chain. | |||
CopyVariableValueEx |
|
Copy the value of a (dynamic) DDVariable to another. | |||
Delay |
|
Delay for a specified number of milliseconds. | |||
DisableDomain |
|
Disable a particular test domain for testing. | |||
EnableDomain |
|
Enable a particular test domain for testing. | |||
Expressions |
|
Enable and Disable enhanced expressions. | |||
GetAppMapValue |
|
Assign a DDVariable a value from an App Map. | |||
GetCompScreenResolution |
|
Gets the current computer screen resolution and returns x and y values. | |||
GetMillisBetweenRecords |
|
Get the pause between two records, and assigns the value to a DDVariable. | |||
GetRegistryKeyValue |
|
Assign the value of the specified Registry Key to a variable. | |||
GetSecsAfterWindowActive |
|
Get the delay after window is activated, and assigns the value to a DDVariable. | |||
GetSecsBeforeMouseDown |
|
Get the delay before mouse down, and assigns the value to a DDVariable. | |||
GetSecsBeforeMouseUp |
|
Get the delay before mouse up, and assigns the value to a DDVariable. | |||
GetSecsDelayRetryComponent |
|
Get the delay of re-finding object, and assigns the value to a DDVariable. | |||
GetSecsSeekComponent |
|
Get the timeout of finding object, and assigns the value to a DDVariable. | |||
GetSystemDate |
|
Assigns the string value of the system date to a DDVariable. | |||
GetSystemDateTime |
|
Assigns the string value of the system datetime to a DDVariable. | |||
GetSystemTime |
|
Assigns the string value of the current system time to a DDVariable. | |||
GetVersion |
|
Get the engine VERSION | |||
LaunchApplication |
|
Identify and Launch a specified application | |||
NotifyAndWait |
|
Display a user-defined message dialog and wait until dismissed. | |||
Pause |
|
Pause for a specified number of seconds. | |||
SaveClipboardToFile |
|
Save the clipboard contents to a text file. | |||
ScrollWheel |
|
Move mouse wheel forward (up) or backward (down). | |||
SendEmail |
|
Send email notification with attachments. | |||
SetApplicationMap |
|
Provide the Application Map for the DDE to use | |||
SetBenchDirectory |
|
Set/Change the directory in which the framework will find benchmark files by default. | |||
SetClipboard |
|
Set the clipboard contents to a string. | |||
SetContext |
|
Set a Window or Window Component as the current Robot context. | |||
SetDifDirectory |
|
Set/Change the directory in which the framework will locate file compare differences. | |||
SetFocus |
|
Give a Window or Window Component input focus. | |||
SetImageDebug |
|
Enable/Disable verbose debug log output and high-res failure snapshots. | |||
SetImageFuzzyMatching |
|
Enable/Disable Image-Based Testing Fuzzy Matching. | |||
SetMillisBetweenRecords |
|
Set the pause between two records. | |||
SetMultipleThreadSearch |
|
Turn on or trun off the multi-thread-search way to search an image. | |||
SetProjectDirectory |
|
Set/Change the framework project directory. | |||
SetRootVerifyDirectory |
|
Set/Change the Bench, Test, and Dif directories to be subdirectories off of the provided path. | |||
SetSecsAfterWindowActive |
|
Set the delay after window is activated. | |||
SetSecsBeforeMouseDown |
|
Set the delay before mouse down. | |||
SetSecsBeforeMouseUp |
|
Set the delay before mouse up. | |||
SetSecsDelayRetryComponent |
|
Set the delay of re-finding object. | |||
SetSecsSeekComponent |
|
Set the timeout of finding object. | |||
SetTestDirectory |
|
Set/Change the directory in which the framework will find test files (captured "actuals") by default. | |||
SetVariableValueEx |
|
Set the value of a DDVariable | |||
SetVariableValues |
|
Preset the value of one or more DDVariables | |||
StartWebBrowser |
|
Launch a new web browser and optionally load a document into it. | |||
TakeScreenShot |
|
Take screenshot and save it to a file on test machine. | |||
UseAbbotFunctions |
|
Enable/Disable the switch to "prefer" ABBOT Functions over any other engine functions. | |||
UseDroidFunctions |
|
Enable/Disable the switch to "prefer" Droid Functions over the current engine functions (like Robot Classic). | |||
UseIOSFunctions |
|
Enable/Disable the switch to "prefer" IOS Functions over any other engine functions. | |||
UseQTPFunctions |
|
Enable/Disable the switch to "prefer" QTP Functions over any other engine functions. | |||
UseRobotJFunctions |
|
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over Robot Classic Component Functions. | |||
UseSAFSFunctions |
|
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over the current engine functions (like Robot Classic). | |||
UseSeleniumFunctions |
|
Enable/Disable the switch to "prefer" Selenium Functions over the current engine functions (like Robot Classic). | |||
UseTestCompleteFunctions |
|
Enable/Disable the switch to "prefer" TestComplete (TCAFS) Functions over any other engine functions. | |||
VerifyClipboardToFile |
|
Verify the current contents of the Windows clipboard with a benchmark file. | |||
Version |
|
Specify the table format VERSION | |||
WaitForGUI |
|
Wait for a Window or Window Component to become valid. | |||
WaitForGUIGone |
|
Wait for a Window or Window Component to become invalid. | |||
WaitForPropertyValue |
|
Wait for a specific Window or Component property value to match an expected value. | |||
WaitForPropertyValueGone |
|
Wait for a specific Window or Component property value to change from a known value. | |||
WaitForRegistryKeyExists |
|
Wait for a Registry Key to become valid. | |||
WaitForRegistryKeyValue |
|
Wait for a specific Registry KeyValue to match an expected value. | |||
WaitForWebPage |
|
Wait for a web document to finish loading within a timeout period. |
DDDriverCounterCommands [How To Read This Reference]
DeleteCounter |
|
Delete any existing private counter with the provided counterID. | |
LogCounterInfo |
|
Log the specified counter's info in the active log(s) of the current Log Facility. | |
ResetCounter |
|
Create a new private counter or reset counts in an existing private counter. | |
ResumeStatusCounts |
|
Resume counting on ALL status counters--both public/global and private. | |
SetCounterMode |
|
Create a new private counter or modify the mode of an existing private counter. | |
StartCounter |
|
Create a new private counter or start an existing stopped private counter. | |
StartCycle |
|
Begin tracking status on a user-defined item. | |
StartProcedure |
|
Begin tracking status on a user-defined item. | |
StartRequirement |
|
Begin tracking status on a user-defined item. | |
StartSuite |
|
Begin tracking status on a user-defined item. | |
StartTestcase |
|
Begin tracking status on a user-defined TestCase. | |
StopCounter |
|
Create a new private counter or suspend counts in an existing private counter. | |
StopCycle |
|
Stop tracking status on a user-defined item. | |
StopProcedure |
|
Stop tracking status on a user-defined item. | |
StopRequirement |
|
Stop tracking status on a user-defined item. | |
StopSuite |
|
Stop tracking status on a user-defined item. | |
StopTestcase |
|
Stop tracking status on a user-defined TestCase. | |
StoreCounterInfo |
|
Store the current values of the named counter into unique DDVariables. | |
SuspendStatusCounts |
|
Suspend counting on ALL status counters--both public/global and private. |
DDDriverDatabaseCommands [How To Read This Reference]
CopyDBTableColumnToFile |
|
This routine will copy the contents of one or more DBTable column(s) to a file. | |||
CopyDBTableToFile |
|
This routine will copy the contents of a DBTable to a file. | |||
DeleteDBTableRecords |
|
Deletes records in a database table | |||
ExecSQLQuery |
|
Executes the query provided in a queryStr on the database table. | |||
GetDBTableColumnCount |
|
Executes the query in a specified database table and returns the total column count. | |||
GetDBTableRowCount |
|
Executes the query in a database table. | |||
GetDBValue |
|
Executes the query and returns the case-sensitive value as result of the execution. | |||
SetJdbcDriver |
|
set Jdbc Driver | |||
VerifyDatabaseNullValue |
|
Verifies the value of a field in a database table is NULL | |||
VerifyDatabaseValue |
|
Verifies the case-sensitive value of a field in a database table | |||
VerifyDBNullValue |
|
Verifies the value of a field in a database table is NULL | |||
VerifyDBValue |
|
Verifies the case-sensitive value of a field in a database table |
DDDriverDebugCommands [How To Read This Reference]
Breakpoints |
|
Enable and Disable Breakpoint Debugging. | |||
CommandDebug |
|
Enable and Disable (C)Command Debugging. | |||
RecordsDebug |
|
Enable and Disable debugging of ALL record types. | |||
TestDebug |
|
Enable and Disable (T)Test Record Debugging. |
DDDriverFileCommands [How To Read This Reference]
CloseFile |
|
Close the open file with the file number provided | |||
CopyFile |
|
Copy the specified filename to the target filename. | |||
CopyMatchingFiles |
|
Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another. | |||
CreateDirectory |
|
Create the directory for the provided directory pathname | |||
CreateFile |
|
Open a new file with the filename, mode and access provided.TID Note: Three ways to create a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write | |||
DeleteDirectory |
|
Delete the directory for the provided directory pathname | |||
DeleteDirectoryContents |
|
Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself. | |||
DeleteFile |
|
Delete the file for the file name provided | |||
FilterImage |
|
Filter out specific parts of an image. | |||
FilterTextFile |
|
Filter a text file based on the given parameters. | |||
FindSqaFile |
|
Find the file for the SQA relative path and file name provided. If a full file path is provided the file will be located using the full file path and name. | |||
GetFileDateTime |
|
Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable. | |||
GetFileProtections |
|
Save the file attributes for the file name to the variable provided. | |||
GetFiles |
|
Search the directory provided for files according to possible attribute and write the list of filenames found into the output file. | |||
GetFileSize |
|
Determine the file size for file name provided and assign it to a DDV variable. | |||
GetINIFileValue |
|
Get value from INI file. | |||
GetStringCountInFile |
|
Count the number of occurrences of a target string in a File. | |||
GetSubstringsInFile |
|
Extract dynamic substrings from a file using regular expressions. | |||
GetTextFromImage |
|
Incorporate OCR technology to detect the text in an image file and save the text to a variable. | |||
IfExistDir |
|
If the specified directory exists, then execute the following driver command. | |||
IfExistFile |
|
If the specified file exists, then execute the following driver command. | |||
IsEndOfFile |
|
If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false | |||
OpenFile |
|
Open an existing file with the filename, mode and access provided.TID Note: Three ways to open a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write | |||
OpenUTF8File |
|
Open an existing UTF-8 file with the filename, mode and access provided.TID Note: Three ways to open a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write | |||
PrintToFile |
|
Write output to a sequential file already opened for writing. | |||
ReadFileChars |
|
Read the number of characters from the file defined by file number and assign a string containing the characters read to a DDV variable. | |||
ReadFileLine |
|
Read a line from the file defined by file number and assign a string containing the line read to a DDV variable. | |||
RenameFile |
|
Rename the file from the old file name to the new filename | |||
SaveTextFromImage |
|
Incorporate OCR technology to detect the text in an image file and save the text to a text file. | |||
SetFileProtections |
|
Change the file attribute for the file name provided to the value of the new file protection provided. | |||
WriteFileChars |
|
Write the specified number of characters to a file already opened for writing. |
DDDriverFlowCommands [How To Read This Reference]
CallCycle |
|
Invoke a Cycle table (from StepDriver or SuiteDriver) | ||
CallJUnit | Invoke one or more JUnit tests using the provided Class name(s). | |||
CallScript |
|
Invoke a custom script with passed parameters/variables, if desired. | ||
CallStep |
|
Invoke a Step table from within another Step table (from StepDriver). | ||
CallSuite |
|
Invoke a Suite table (from StepDriver or SuiteDriver) | ||
ExitCycle |
|
Exit the currently running Step, Suite, and/or Cycle table. | ||
ExitSuite |
|
Exit the currently running Step and/or Suite table. | ||
ExitTable |
|
Exit the currently running Step, Suite, or Cycle table. | ||
GotoBlockID |
|
Goto a named block in the current table. | ||
OnContainsGotoBlockID |
|
Goto the named block in the current table if value2 is contained within value1. | ||
OnDirectoryExistGotoBlockID |
|
Goto the named block in the current table if the directory exists. | ||
OnDirectoryNotExistGotoBlockID |
|
Goto the named block in the current table if the Directory does not exist. | ||
OnEqualGotoBlockID |
|
Goto the named block in the current table if two values are equal. | ||
OnFileEOFGotoBlockID |
|
Goto the named block in the current table if the file is at EOF. | ||
OnFileExistGotoBlockID |
|
Goto the named block in the current table if the file exists. | ||
OnFileNotExistGotoBlockID |
|
Goto the named block in the current table if the file does not exist. | ||
OnGreaterThanGotoBlockID |
|
Goto the named block in the current table if value1 is greater than value2. | ||
OnGUIExistsGotoBlockID |
|
Goto the named block in the current table if a GUI component exists. | ||
OnGUINotExistGotoBlockID |
|
Goto the named block in the current table if a GUI component does not exist. | ||
OnInRangeGotoBlockID |
|
Goto named block if value1 is between value2 and value3. | ||
OnLessThanGotoBlockID |
|
Goto the named block if value1 is less than value2. | ||
OnMenuItemContainsStateGotoBlockID |
|
Goto the named block in the current table if state is part of the state information of the menuitem. | ||
OnNotContainsGotoBlockID |
|
Goto the named block in the current table if value2 is NOT a substring of value1. | ||
OnNotEqualGotoBlockID |
|
Goto the named block in the current table if two values are not equal. | ||
OnNotGreaterThanGotoBlockID |
|
Goto the named block in the current table if value1 is NOT greater than value2. | ||
OnNotInRangeGotoBlockID |
|
Goto the named block in the current table if value1 is not between value2 and value3. | ||
OnNotLessThanGotoBlockID |
|
Goto the named block if value1 is NOT less than value2. | ||
OnRegistryKeyExistGotoBlockID |
|
Goto the named block in the current table if the Registry Key exists. | ||
OnRegistryKeyNotExistGotoBlockID |
|
Goto the named block in the current table if the Registry Key does not exist. | ||
SetExitTableBlock |
|
Set or clear the name of a block to execute when the ExitTable command is encountered. | ||
SetGeneralScriptFailureBlock |
|
Set or clear the name of a block to execute when GeneralScriptFailure occurs. | ||
SetInvalidFileIOBlock |
|
Set or clear the name of a block to execute when InvalidFileIO occurs. | ||
SetNoScriptFailureBlock |
|
Set or clear the name of a block to execute when NoScriptFailure occurs. | ||
SetScriptNotExecutedBlock |
|
Set or clear the name of a block to execute when ScriptNotExecuted occurs. | ||
SetScriptWarningBlock |
|
Set or clear the name of a block to execute when ScriptWarning occurs. | ||
UseLocalFlowControl |
|
When TRUE then flow control block IDs have current table scope only. |
DDDriverLogCommands [How To Read This Reference]
LogFailureOK |
|
Log an EXPECTED failure message. | |
LogMessage |
|
Log a generic message | |
LogTestFailure |
|
Log a FAILURE message. Also increments appropriate counters. | |
LogTestSuccess |
|
Log a SUCCESS/OK message. Also increments appropriate counters. | |
LogTestWarning |
|
Log a WARNING message. Also increments appropriate counters. | |
LogWarningOK |
|
Log an EXPECTED WARNING message. | |
ResumeLogging |
|
Resume suspended logging. | |
SuspendLogging |
|
Suspend all logging. |
DDDriverStringCommands [How To Read This Reference]
CleanString |
|
CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it, otherwise turn it into a space | |||
Compare |
|
Compares two strings and returns an integer specifying the result of the comparison. The java version uses String.equals() for comparison so the result will be either 'true' or 'false' | |||
Concatenate |
|
Concatenate String1 with String2 and returns concatenated string. | |||
GetField |
|
GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present. | |||
GetFieldCount |
|
GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord. | |||
GetFixedWidthField |
|
GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record. | |||
GetMultiDelimitedField |
|
Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex. The startIndex and fieldID are 1 based. | |||
GetMultiDelimitedFieldCount |
|
Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord. The field and index are 1-based. | |||
GetNextDelimiterIndex |
|
GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters. The search begins at startindex within the inputRecord. | |||
GetREDelimitedField |
|
GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s). | |||
GetREDelimitedFieldCount |
|
GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s). | |||
GetSubstringsInString |
|
Extract dynamic substring from a string using regular expressions. | |||
GetSystemEnviron |
|
GetSystemEnviron, get a system environment variable value | |||
GetSystemUser |
|
Get the USERID of the currently logged on user as stored in System Environment variables. | |||
GetTrimmedField |
|
GetTrimmedField, get a trimmed field out of a string using specified delimiter(s). | |||
Index |
|
Returns the position of the first occurrence of one string within another string. -1 if not found at all | |||
Left |
|
Returns a string of a specified number of characters copied from the beginning of another string. | |||
LeftTrim |
|
A new string trimmed of leading tabs and spaces. | |||
Length |
|
Returns the length of a string or variable. | |||
Replace |
|
Replace 'find' substring with 'replace' substring | |||
Right |
|
Returns a string of a specified number of characters copied from the end of another string. | |||
RightTrim |
|
A new string trimmed of trailing tabs and spaces. | |||
SubString |
|
Returns a portion of a string based on character index. | |||
ToLowerCase |
|
Returns a copy of a string, with all letters converted to lowercase. | |||
ToUpperCase |
|
Returns a copy of a string after converting all letters to uppercase. | |||
Trim |
|
A new string trimmed of leading and trailing tabs and spaces. |
DDDriverTimerCommands [How To Read This Reference]
ResetTimer |
|
Reset a "stopped" timer for reuse. | |||
StartTimer |
|
Will start a unique timer. | |||
StopTimer |
|
Will end a unique timer and perform a verify test if a value was supplied at start time. | |||
StoreTimerInfo |
|
Well store the timer information in the given variable. Information stored: .elapsed - Amount of seconds that has passed. .startTime - Time that the timer was started. .endTime - Time that the timer was stopped. .failures - Number of failures that happened on the timer (based on verify commands). | |||
StoreTimerInfoFile |
|
Well store the timer information in the given file, in csv format. Will use absolute path if given otherwise uses SAFS Project Directory. Information Stored:Name,Start,Stop,Duration,Timeout,Pass? Name - Name of timer Start - Time of start Stop - Time of stop Duration - total elapsed time. Timeout - Pass? - if the timer passed any verfiy commands. Variable TimerStorageVariables can list additional variables to be stored in the file (comma delimited). | |||
VerifyElapsedTimeInRange |
|
Well verify that a timer was in the range of the given values. | |||
VerifyElapsedTimeIsLess |
|
Well verify that a timer was less then the given value. | |||
VerifyElapsedTimeIsMore |
|
Well verify that a timer was greater then the given value. | |||
VerifyTimer |
|
Well verify that a timer was less then the given value. |
CheckBoxFunctions [How To Read This Reference]
Check |
|
Tries to perform a Check on the Checkbox. | |
UnCheck |
|
Tries to perform a UnCheck on the Checkbox. |
ComboBoxFunctions [How To Read This Reference]
CaptureItemsToFile |
|
Capture Items To a File specified (if not abs, then to test dir) | |
HideList |
|
Hide the combo box list (equivalent to an ESC or two ESCs). | |
Select |
|
Select an item by its text value from a combobox. | |
SelectIndex |
|
Select an item by its index from a combobox. | |
SelectPartialMatch |
|
Select an item via a partial text match in a combobox. | |
SelectUnverified |
|
Select an item by its text value from a combobox without verifying the selection. | |
SetTextValue |
|
Set the text of the combobox | |
SetUnverifiedTextValue |
|
Set the text of the combobox without verification | |
ShowList |
|
Show the combo box list (expose it). | |
VerifySelected |
|
Verify Selected item is equal to specified parameter |
DatabaseFunctions [How To Read This Reference]
CopyDBTableColumnToFile |
|
This routine will copy the contents of one or more DBTable column(s) to a file. | |
CopyDBTableToFile |
|
This routine will copy the contents of a DBTable to a file. | |
DeleteDBTableRecords |
|
Deletes records in a database table | |
ExecSQLCommit |
|
This routine will commit the pending queries on the database. | |
ExecSQLQuery |
|
Executes the query provided in a ^queryStr on the database table. | |
GetDBTableColumnCount |
|
Executes the query in a specified database table and returns the total column count. | |
GetDBTableRowCount |
|
Executes the query in a database table. | |
GetDBValue |
|
Executes the query and returns the case-sensitive value as result of the execution. | |
VerifyDatabaseNullValue |
|
Verifies the value of a field in a database table is NULL | |
VerifyDatabaseValue |
|
Verifies the case-sensitive value of a field in a database table | |
VerifyDBNullValue |
|
Verifies the value of a field in a database table is NULL | |
VerifyDBValue |
|
Verifies the case-sensitive value of a field in a database table |
EditBoxFunctions [How To Read This Reference]
SetTextCharacters |
|
Set the text of the editbox | |
SetTextValue |
|
Set the text of the editbox | |
SetUnverifiedTextCharacters |
|
Set the text of the editbox | |
SetUnverifiedTextValue |
|
Set the text of the editbox without verification |
FlexColorFunctions [How To Read This Reference]
SetColor |
|
Action to set a color according to its color value. Currently, this component function is for Flex ColorPicker only. |
FlexDateFunctions [How To Read This Reference]
SetDate |
|
Action to set date for a date component according to its DateValue. Currently, this component function is for Flex Date components only. |
FlexNumericStepperFunctions [How To Read This Reference]
SetValue |
|
Action to set the value of the stepper according to its StepperValue. Currently, this component function is for Flex NumericStepper only. |
FlexSliderFunctions [How To Read This Reference]
SetValue |
|
Action to set the value of the slider according to its SliderValue. Currently, this component function is for Flex Slider only. |
GenericMasterFunctions [How To Read This Reference]
AssignPropertyVariable |
|
Assign the string value of an object property to a specific DDVariable | ||
CaptureObjectDataToFile |
|
Copy the current contents of an object's data to a file. | ||
CapturePropertiesToFile |
|
Copy all of the value properties a test object to a file. | ||
CapturePropertyToFile |
|
Copy a propertie's value of a test object to to a file. | ||
ClearAppMapCache |
|
Clear the internal application map cache. | ||
GetGUIImage |
|
Capture the screen shot of a GUI component and save it to a file | ||
GetTextFromGUI |
|
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable. | ||
GUIDoesExist |
|
Routine to verify the visual existence of a particular window and/or component. | ||
GUIDoesNotExist |
|
Routine to verify the visual non-existence of a particular window and/or component. | ||
HoverMouse |
|
Hover the mouse over an object. | ||
HoverScreenLocation |
|
Hover the mouse over a specified screen location. | ||
InputCharacters |
|
Sends literal text to the specified component. | ||
InputKeys |
|
Sends keystrokes to the specified component. | ||
IsPropertyExist |
|
Verify if object's property exists or not. | ||
LocateScreenImage |
|
Store the location and dimensions of a component. | ||
SaveTextFromGUI |
|
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file. | ||
SendEvent |
|
Send or trigger an "event" with 0 or more arguments. | ||
SetPropertyValue |
|
Sets a value to the property of an object. | ||
TypeChars |
|
Sends literal text keystrokes to whatever has keyboard focus. | ||
TypeEncryption |
|
Sends secret-text (such as password) to whatever has keyboard focus. | ||
TypeKeys |
|
Sends keystrokes to whatever has keyboard focus. | ||
VerifyArrayPropertyToFile |
|
Verify the value of an array property with a benchmark file | ||
VerifyBinaryFileToFile |
|
Verify the current contents of a binary file with a benchmark file. | ||
VerifyClipboardToFile |
|
Verify the current contents of the Windows clipboard with a benchmark file. | ||
VerifyFileToFile |
|
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile). | ||
VerifyGUIImageToFile |
|
Verify the screen shot of a GUI component with a benchmark image file | ||
VerifyObjectDataToFile |
|
Verify the current contents of an object's data with a benchmark file. | ||
VerifyProperty |
|
Verify the value of a single object property | ||
VerifyPropertyContains |
|
Verify that the value of an object property contains a string | ||
VerifyPropertyToFile |
|
Verify the value of a single object property with a benchmark file | ||
VerifyTextFileToFile |
|
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile). | ||
VerifyValueContains |
|
Verify that a string value contains a substring | ||
VerifyValueContainsIgnoreCase |
|
Verify that a string value contains a substring, ignoring case. | ||
VerifyValueDoesNotContain |
|
Verify that a string value does NOT contain a substring | ||
VerifyValues |
|
Verify that two string values are identical. Note: RobotJ also uses identical keyword 'VerifyValueEquals' | ||
VerifyValuesIgnoreCase |
|
Verify that two string values are identical, ignoring case. | ||
VerifyValuesNotEqual |
|
Verify that two string values are NOT identical. |
GenericObjectFunctions [How To Read This Reference]
AltLeftDrag |
|
An ALT left mouse drag is performed on the object based on the stored coordinates. | ||
Click |
|
A single click on an object. | ||
ClickScreenImage |
|
Same as Click. | ||
ClickScreenLocation |
|
Click a specified screen location. | ||
ClickScreenPoint |
|
(Deprecated) Click a specified screen location. | ||
CtrlAltLeftDrag |
|
CTRL ALT left mouse drag is performed on the object based on the stored coordinates. | ||
CtrlClick |
|
A CTRL-click on an object. | ||
CtrlClickScreenImage |
|
Same as CtrlClick. | ||
CtrlLeftDrag |
|
A CTRL left mouse drag is performed on the object based on the stored coordinates. | ||
CtrlRightClick |
|
A CTRL-Right click on an object. | ||
CtrlRightClickScreenImage |
|
Same as CtrlRightClick. | ||
CtrlShiftLeftDrag |
|
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates. | ||
DoubleClick |
|
A double click on an object. | ||
DoubleClickScreenImage |
|
Same as DoubleClick. | ||
DoubleClickScreenLocation |
|
DoubleClick a specified screen location. | ||
DoubleClickScreenPoint |
|
(Deprecated) DoubleClick a specified screen location. | ||
HScrollTo |
|
Attempts to perform an HScrollTo on an object. | ||
LeftDrag |
|
A left mouse drag is performed on the object based on the stored coordinates. | ||
MouseClick |
|
A single click on an object by mouse event. It uses low level mouse event to click on an object. | ||
MultiClick |
|
Multiple clicks on an object. | ||
MultiClickScreenImage |
|
Same as MULTICLICK. | ||
RightClick |
|
A right click on an object. | ||
RightClickScreenImage |
|
Same as RightClick. | ||
RightClickScreenLocation |
|
RightClick a specified screen location. | ||
RightClickScreenPoint |
|
(Deprecated) RightClick a specified screen location. | ||
RightDrag |
|
A right mouse drag is performed on the object based on the stored coordinates. | ||
ShiftClick |
|
A SHIFT click on an object. | ||
ShiftClickScreenImage |
|
Same as ShiftClick. | ||
ShiftLeftDrag |
|
A SHIFT left mouse drag is performed on the object based on the stored coordinates. | ||
VScrollTo |
|
Attempts to perform a VScrollTo on an object. |
HTMLDocumentFunctions [How To Read This Reference]
CaptureBodySourceToFile |
|
Captures the HTML source of the BODY tag into a file. | |
CaptureBodyTextToFile |
|
Captures the visible document text into a file. | |
ClickLink |
|
Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object. | |
ClickLinkBeginning |
|
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. | |
ClickLinkContaining |
|
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object. | |
VerifyBodySource |
|
Compares the HTML source of the BODY tag with that of a benchmark file. | |
VerifyBodyText |
|
Compares the visible doc text with that of a benchmark file. |
HTMLImageFunctions [How To Read This Reference]
ClickArea |
|
Attempts to perform a Click on a mapped region of an Image (on a webpage). | |
SaveHTMLImage |
|
Attempts to Save an HTMLImage on a webpage. | |
VerifyHTMLImage |
|
Attempts to verify an HTMLImage on a webpage to a benchmark file. |
HTMLTableFunctions [How To Read This Reference]
ActivateCell |
|
Attempts to perform a double click on a Table cell. | |
AssignCellContainsTextRow |
|
Assigns a user-defined variable a row # based on partial matching cell values. | |
AssignCellTextRow |
|
Assigns a user-defined variable a row # based on matching cell values. | |
AssignVariableCellText |
|
Attempts to extract a particular cell value and assign it to the provided variable name. | |
CaptureFuzzyRangeToFile |
|
Saves a range of values to the specified file. | |
CaptureRangeToFile |
|
Saves a range of values to the specified file. | |
ClickCell |
|
Click on a cell specified by row and column. | |
DoubleClickCell |
|
Attempts to perform a double click on a cell in a Table. | |
RightClickCell |
|
Attempts to perform a right click on a cell in a Table. | |
SelectCell |
|
Same as ClickCell. | |
SelectCellContainsTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellText |
|
Attempts to select a particular cell. | |
SelectCellTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellTextSpecial |
|
Holds down either key Control or Shift while making a cell selection with emulating either a Left or Right mouse click. | |
SelectFuzzyCellText |
|
Attempts to select a particular cell. | |
SelectFuzzyCellTextFind |
|
Attempts to select a particular cell by finding the row based on fuzzy cell values. | |
VerifyCellEditable |
|
Verifies whether the specified cell is editable. | |
VerifyCellText |
|
Attempts to verify a particular cell value. | |
VerifyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on cell values. | |
VerifyCellValue |
|
Verify the value of a specific Cell. | |
VerifyColumnLabel |
|
Attempts to verify a particular column's label when given a column number. | |
VerifyFuzzyCellText |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on fuzzy cell values. |
JavaMenuFunctions [How To Read This Reference]
SelectMenuItem |
|
Action to select a menuItem according to its text value. | |
SelectMenuItemContains |
|
Action to select a menuItem according to a partial match of its text value. | |
SelectUnverifiedMenuItem |
|
Action to select a menuItem according to its text value without verification of it's existance. | |
VerifyMenuItem |
|
Attempts to verify the a particular menuitem exists in a menu. | |
VerifyMenuItemContains |
|
Attempts to verify the existence of a menuitem found by partial text match. |
JavaTableFunctions [How To Read This Reference]
ActivateCell |
|
Attempts to perform a double click on a JavaTable cell. | |
ActivateColumnLabel |
|
Double clicks on the label of the specified column. | |
AssignCellContainsTextRow |
|
Assigns a user-defined variable a row # based on partial matching cell values. | |
AssignCellTextRow |
|
Assigns a user-defined variable a row # based on matching cell values. | |
AssignVariableCellText |
|
Attempts to extract a particular cell value and assign it to the provided variable name. | |
AssignVariableFuzzyCellText |
|
Attempts to extract a particular cell value and assign it to the provided variable name. | |
CaptureFuzzyRangeToFile |
|
Saves a range of values to the specified file. | |
CaptureRangeToFile |
|
Saves a range of values to the specified file. | |
ClickCell |
|
Attempts to perform a Click on a cell in a JavaTable. | |
ClickColumnLabel |
|
Clicks on the label of the specified column. | |
DoubleClickCell |
|
Attempts to perform a double click on a cell in a JavaTable. | |
DoubleClickColumnLabel |
|
Double clicks on the label of the specified column. | |
RightClickCell |
|
Attempts to perform a right click on a cell in a JavaTable. | |
RightClickColumnLabel |
|
Right clicks on the label of the specified column. | |
SelectCell |
|
Same as ClickCell. | |
SelectCellContainsTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellText |
|
Attempts to select a particular cell. | |
SelectCellTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellTextSpecial |
|
Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click. | |
SelectFuzzyCellText |
|
Attempts to select a particular cell. | |
SelectFuzzyCellTextFind |
|
Attempts to select a particular cell by finding the row based on fuzzy cell values. | |
VerifyCellEditable |
|
Verifies whether the specified cell is editable. | |
VerifyCellText |
|
Attempts to verify a particular cell value. | |
VerifyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on cell values. | |
VerifyColumnLabel |
|
Attempts to verify a particular column's label when given a column number. | |
VerifyFuzzyCellText |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on fuzzy cell values. |
JavaTreeFunctions [How To Read This Reference]
CaptureTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file. | |
ClickTextNode |
|
Action to click a node according to its text value. Currently, this component function is for JavaTrees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
ClickUnverifiedTextNode |
|
Action to blindly click a node according to its text value. Currently, this component function is for JavaTrees and may work differently than documented in TreeViewFunctions. | |
Collapse |
|
Use CollapseTextNode instead. | |
CollapsePartialTextNode |
|
Action to collapse a node according to a partial match of its text value. | |
CollapseTextNode |
|
Action to collapse a node according to its text value. | |
CollapseUnverifiedTextNode |
|
Action to blindly collapse a node according to its text value. | |
CtrlClickUnverifiedTextNode |
|
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only. | |
DoubleClickTextNode |
|
Action to double-click a node according to its text value. Currently, this component function is for JavaTrees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
DoubleClickUnverifiedTextNode |
|
Action to blindly double-click a node according to its text value. Currently, this component function is for JavaTrees and may work differently than documented in TreeViewFunctions. | |
Expand |
|
Use ExpandTextNode instead. | |
ExpandPartialTextNode |
|
Action to expand a node according to a partial match of text value. | |
ExpandTextNode |
|
Action to expand a node according to its text value. | |
ExpandUnverifiedTextNode |
|
Action to blindly expand a node according to its text value. | |
MakeSelection |
|
Use SelectTextNode instead. | |
PartialMatchTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file according to a partial match of its text value. | |
RightClickTextNode |
|
Action to right-click a node according to its text value. Currently, this component function is for JavaTrees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
RightClickUnverifiedTextNode |
|
Action to blindly right-click a node according to its text value. Currently, this component function is for JavaTrees and may work differently than documented in TreeViewFunctions. | |
SelectAnotherPartialTextNode |
|
Action to select a node according to a partial match of its text value, in addition to any nodes already selected. Performs selection as if CTRL key were held down during selection. | |
SelectAnotherTextNode |
|
Action to select a node according to its text value, in addition to any nodes already selected. | |
SelectAnotherUnverifiedTextNode |
|
Action to blindly select a node according to its text value, in addition to any nodes already selected. | |
SelectPartialTextNode |
|
Action to select a node according to a partial match of its text value. Performs selection as if CTRL key were held down during selection. | |
SelectTextNode |
|
Action to select a node according to its text value. | |
SelectUnverifiedTextNode |
|
Action to blindly select a node according to its text value. | |
SetTreeContainsNode |
|
Sets a user-defined variable with the result of whether a tree contains the provided node. | |
SetTreeContainsPartialMatch |
|
Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value. | |
ShiftClickUnverifiedTextNode |
|
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only. | |
VerifyTreeContainsNode |
|
Verify that a tree contains the provided node. | |
VerifyTreeContainsPartialMatch |
|
Verify that a tree contains the provided node according to a partial match of the node's text value. |
DotNetTableFunctions [How To Read This Reference]
ActivateCell |
|
Attempts to perform a double click on a DotNetTable cell. | |
ActivateColumnLabel |
|
Double clicks on the label of the specified column. | |
AssignCellContainsTextRow |
|
Assigns a user-defined variable a row # based on partial matching cell values. | |
AssignCellTextRow |
|
Assigns a user-defined variable a row # based on matching cell values. | |
AssignVariableCellText |
|
Attempts to extract a particular cell value and assign it to the provided variable name. | |
AssignVariableFuzzyCellText |
|
Attempts to extract a particular cell value and assign it to the provided variable name. | |
CaptureFuzzyRangeToFile |
|
Saves a range of values to the specified file. | |
CaptureRangeToFile |
|
Saves a range of values to the specified file. | |
ClickCell |
|
Attempts to perform a Click on a cell in a DotNetTable. | |
ClickColumnLabel |
|
Clicks on the label of the specified column. | |
DoubleClickCell |
|
Attempts to perform a double click on a cell in a DotNetTable. | |
DoubleClickColumnLabel |
|
Double clicks on the label of the specified column. | |
RightClickCell |
|
Attempts to perform a right click on a cell in a DotNetTable. | |
SelectCell |
|
Same as ClickCell. | |
SelectCellContainsTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellText |
|
Attempts to select a particular cell. | |
SelectCellTextFind |
|
Attempts to select a particular cell by finding the row based on cell values. | |
SelectCellTextSpecial |
|
Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click. | |
SelectFuzzyCellText |
|
Attempts to select a particular cell. | |
SelectFuzzyCellTextFind |
|
Attempts to select a particular cell by finding the row based on fuzzy cell values. | |
VerifyCellEditable |
|
Verifies whether the specified cell is editable. | |
VerifyCellText |
|
Attempts to verify a particular cell value. | |
VerifyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on cell values. | |
VerifyColumnLabel |
|
Attempts to verify a particular column's label when given a column number. | |
VerifyFuzzyCellText |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextContains |
|
Attempts to verify a particular cell value. | |
VerifyFuzzyCellTextFind |
|
Attempts to verify a particular cell by finding the row based on fuzzy cell values. |
DotNetMenuFunctions [How To Read This Reference]
SelectMenuItem |
|
Action to select a menuItem according to its text value. | |
SelectMenuItemContains |
|
Action to select a menuItem according to a partial match of its text value. | |
VerifyMenuItem |
|
Attempts to verify the a particular menuitem exists in a menu. | |
VerifyMenuItemContains |
|
Attempts to verify the existence of a menuitem found by partial text match. |
DotNetTreeFunctions [How To Read This Reference]
CaptureTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file. | |
ClickTextNode |
|
Action to click a node according to its text value. Currently, this component function is for Trees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
ClickUnverifiedTextNode |
|
Action to blindly click a node according to its text value. Currently, this component function is for Trees and may work differently than documented in TreeViewFunctions. | |
Collapse |
|
Use CollapseTextNode instead. | |
CollapsePartialTextNode |
|
Action to collapse a node according to a partial match of its text value. | |
CollapseTextNode |
|
Action to collapse a node according to its text value. | |
CollapseUnverifiedTextNode |
|
Action to blindly collapse a node according to its text value. | |
CtrlClickUnverifiedTextNode |
|
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for Trees only. | |
DoubleClickTextNode |
|
Action to double-click a node according to its text value. Currently, this component function is for Trees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
DoubleClickUnverifiedTextNode |
|
Action to blindly double-click a node according to its text value. Currently, this component function is for Trees and may work differently than documented in TreeViewFunctions. | |
Expand |
|
Use ExpandTextNode instead. | |
ExpandPartialTextNode |
|
Action to expand a node according to a partial match of text value. | |
ExpandTextNode |
|
Action to expand a node according to its text value. | |
ExpandUnverifiedTextNode |
|
Action to blindly expand a node according to its text value. | |
MakeSelection |
|
Use SelectTextNode instead. | |
PartialMatchTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file according to a partial match of its text value. | |
RightClickTextNode |
|
Action to right-click a node according to its text value. Currently, this component function is for Trees and works differently than documented in TreeViewFunctions (though that functionality may be added in the near future). | |
RightClickUnverifiedTextNode |
|
Action to blindly right-click a node according to its text value. Currently, this component function is for Trees and may work differently than documented in TreeViewFunctions. | |
SelectAnotherPartialTextNode |
|
Action to select a node according to a partial match of its text value, in addition to any nodes already selected. Performs selection as if CTRL key were held down during selection. | |
SelectAnotherTextNode |
|
Action to select a node according to its text value, in addition to any nodes already selected. | |
SelectAnotherUnverifiedTextNode |
|
Action to blindly select a node according to its text value, in addition to any nodes already selected. | |
SelectPartialTextNode |
|
Action to select a node according to a partial match of its text value. Performs selection as if CTRL key were held down during selection. | |
SelectTextNode |
|
Action to select a node according to its text value. | |
SelectUnverifiedTextNode |
|
Action to blindly select a node according to its text value. | |
SetTreeContainsNode |
|
Sets a user-defined variable with the result of whether a tree contains the provided node. | |
SetTreeContainsPartialMatch |
|
Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value. | |
ShiftClickUnverifiedTextNode |
|
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for Trees only. | |
VerifyTreeContainsNode |
|
Verify that a tree contains the provided node. | |
VerifyTreeContainsPartialMatch |
|
Verify that a tree contains the provided node according to a partial match of the node's text value. |
ListBoxFunctions [How To Read This Reference]
ActivatePartialMatch |
|
Routine to DblClick and Verify an item according to a partial text match. | |
ActivateTextItem |
|
Routine to DblClick and Verify an item according to its text value. | |
ActivateUnverifiedPartialMatch |
|
DblClicks an item according to a partial text match. | |
ActivateUnverifiedTextItem |
|
Routine to DblClick an item according to its text value. | |
CaptureItemsToFile |
|
Capture Items To a File specified (if not abs, then to test dir) | |
ClickColumnIndex |
|
Click a column header based on it's index of list, starting from 1 | |
ClickColumnLabel |
|
Click a column header based on it's label | |
ClickTextItem |
|
Routine to Click a selection according to its text value. Note: This keyword triggers the click event | |
ExtendSelectionToTextItem |
|
Routine to Shift+Click and Verify a selection according to its text value. | |
RightClickTextItem |
|
Routine to Right-Click a selection according to its text value. Note: This keyword triggers the right-click event. | |
SelectAnotherTextItem |
|
Routine to Control+Click and Verify a selection according to its text value. | |
SelectAnotherUnverifiedTextItem |
|
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed. | |
SelectIndex |
|
Select an item based on it's index in the list, starting from 1 | |
SelectPartialMatch |
|
Routine to Click and Verify an item according to a partial text match. | |
SelectTextItem |
|
Routine to Click and Verify a selection according to its text value. | |
SelectUnverifiedPartialMatch |
|
Routine to Click an item according to a partial text match. | |
SelectUnverifiedTextItem |
|
Routine to Click a selection according to its text value. | |
SetListContains |
|
Set a variable with the result of checking that a listview contains the provided item. | |
VerifyItem |
|
Verifies a particular case-sensitive item based on index is equal to a particular value. | |
VerifyItemUnselected |
|
Verifies a particular case-sensitive text item is NOT selected. | |
VerifyListContains |
|
Verifies a particular list-item exists in the list (somewhere) | |
VerifyListContainsPartialMatch |
|
Verifies a particular list-item substring exists in the list (somewhere) | |
VerifyListDoesNotContain |
|
Verifies a particular list-item does NOT exists in the list (somewhere) | |
VerifyListDoesNotContainPartialMatch |
|
Verifies a particular list-item substring does NOT exists in the list (somewhere) | |
VerifyMenuItem |
|
Verifies a particular case-sensitive menu-item exists in the list (somewhere) | |
VerifyMenuPartialMatch |
|
Verifies a particular case-insensitive menu-item substring exists in the list (somewhere) | |
VerifyPartialMatch |
|
Verifies a particular case-insensitive item based on index is has as substring a particular value. | |
VerifySelectedItem |
|
Verifies a particular case-sensitive text item is selected | |
VerifySelectedPartialMatch |
|
Verifies a particular case-sensitive item is selected based on a substring match. |
PopupMenuFunctions [How To Read This Reference]
SelectPopupMenuItem |
|
Select a menuItem via its text in the currently active popup menu. | |
SelectUnverifiedPopupMenuItem |
|
Select a menuItem via its text in the currently active popup menu without verification. | |
VerifyPopupMenu |
|
Verify the complete status of the current popup menu with a benchmark file. | |
VerifyPopupMenuItem |
|
Verify the state of a menuItem found via its text in the currently active popup menu. | |
VerifyPopupMenuPartialMatch |
|
Verify if a menuItem contains a substring |
ScrollBarFunctions [How To Read This Reference]
OneDown |
|
Attempts to perform a ScrollLineDown on a scrollbar. | |
OneLeft |
|
Attempts to perform a ScrollLeft on a scrollbar. | |
OneRight |
|
Attempts to perform a ScrollRight on a scrollbar. | |
OneUp |
|
Attempts to perform a ScrollLineUp on a scrollbar. | |
PageDown |
|
Attempts to perform a ScrollPageDown on a scrollbar. | |
PageLeft |
|
Attempts to perform a ScrollPageLeft on a scrollbar. | |
PageRight |
|
Attempts to perform a ScrollPageRight on a scrollbar. | |
PageUp |
|
Attempts to perform a ScrollPageUp on a scrollbar. |
TabControlFunctions [How To Read This Reference]
ClickTab |
|
Attempts to perform a standard Click on a particular Tab on the TabControl | |
ClickTabContains |
|
Attempts to perform a Click on a Tab according to a partial match of its text value. | |
MakeSelection |
|
Attempts to perform a standard Click on a particular Tab on the TabControl | |
SelectTab |
|
Attempts to perform a standard SelectTab on a particular Tab on the TabControl | |
SelectTabIndex |
|
Attempts to select a particular Tab by Index. | |
UnverifiedClickTab |
|
Attempts to perform an unverified Click on a particular Tab on the TabControl |
ToolBarFunctions [How To Read This Reference]
ClickButtonIndex |
|
Click on the icon at a certain position on the ToolBar object, it is 1-based. | |
ClickButtonText |
|
Routine to Click on the specified Button.Key (Text) value. | |
ClickButtonTooltip |
|
Click on the icon whose tooltip equals to the provided parameter | |
ClickUnverifiedButtonText |
|
Routine to Click on the specified Button.Key (Text) value. |
TreeViewFunctions [How To Read This Reference]
ActivateUnverifiedTextNode |
|
Action to (almost) blindly activate (double-click) a text node. | |
CaptureTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file. | |
ClickPartial |
|
Action to click a node according to a partial match of its text value. | |
ClickTextNode |
|
Action to click a node according to its text value. | |
ClickUnverifiedTextNode |
|
Action to (almost) blindly click a text node. | |
Collapse |
|
Action to collapse a node according to its text value. | |
CollapsePartial |
|
Action to collapse a node according to a partial match of its text value. | |
CollapsePartialTextNode |
|
Action to collapse a node according to a partial match of its text value. | |
CollapseTextNode |
|
Action to collapse a node according to its text value. Use Collapse instead. | |
CollapseUnverifiedTextNode |
|
Action to blindly collapse a node according to its text value. | |
CtrlClickUnverifiedTextNode |
|
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only. | |
DoubleClickPartial |
|
Action to double click a node according to a partial match of its text value. | |
DoubleClickTextNode |
|
Action to double click a node according to its text value. | |
DoubleClickUnverifiedTextNode |
|
Action to (almost) blindly activate (double-click) a text node. | |
Expand |
|
Action to expand a node according to its text value. | |
ExpandPartial |
|
Action to expand a node according to a partial match of text value. | |
ExpandPartialTextNode |
|
Action to expand a node according to a partial match of text value. | |
ExpandTextNode |
|
Action to expand a node according to its text value. Use Expand instead. | |
ExpandUnverifiedTextNode |
|
Action to blindly expand a node according to its text value. | |
PartialMatchTreeDataToFile |
|
Copy the current contents of a tree[branch] to a file according to a partial match of itss text value. | |
RightClickPartial |
|
Action to right click a node according to a partial match of its text value. | |
RightClickTextNode |
|
Action to right click a node according to its text value. | |
RightClickUnverifiedTextNode |
|
Action to (almost) blindly right-click a text node. | |
Select |
|
Action to select a node according to its text value. | |
SelectAnotherPartialTextNode |
|
Action to select a node according to a partial match of its text value, in addition to any nodes already selected. Performs selection as if CTRL key were held down during selection. | |
SelectAnotherTextNode |
|
Action to select a node according to its text value, in addition to any nodes already selected. | |
SelectAnotherUnverifiedTextNode |
|
Action to blindly select a node according to its text value, in addition to any nodes already selected. | |
SelectPartial |
|
Action to select a node according to a partial match of its text value. | |
SelectPartialTextNode |
|
Action to select a node according to a partial match of its text value. Performs selection as if CTRL key were held down during selection. | |
SelectTextNode |
|
Action to select a node according to its text value. | |
SelectUnverifiedTextNode |
|
Action to (almost) blindly click a text node. | |
SetTreeContainsNode |
|
Sets a user-defined variable with the result of whether a tree contains the provided node. | |
SetTreeContainsPartialMatch |
|
Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value. | |
ShiftClickUnverifiedTextNode |
|
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only. | |
VerifyNodeUnselected |
|
Action to verify a particular text node is NOT selected. | |
VerifySelectedNode |
|
Action to verify a particular text node is selected. | |
VerifyTreeContainsNode |
|
Verify that a tree contains the provided node. | |
VerifyTreeContainsPartialMatch |
|
Verify that a tree contains the provided node according to a partial match of the node's text value. |
WindowFunctions [How To Read This Reference]
CloseWindow |
|
Sends a Close command to the active window. | |
Maximize |
|
Sends a WMaximize command to the active window. | |
Minimize |
|
Sends a WMinimize command to the active window. | |
Restore |
|
Sends a RestorePos command to the active window. | |
SelectMenuItem |
|
Attempts to select a particular text string menuitem. | |
SelectMenuItemContains |
|
Attempts to select a menuitem based on a partial text match. | |
SetPosition |
|
Sends a SetPosition command to the window to set the position, size, and status of the window. | |
VerifyMenuItem |
|
Attempts to verify the state information of a particular text string menuitem. | |
VerifyMenuItemContains |
|
Attempts to verify the state information of a menuitem found by partial text match. |
EngineComponentCommands [How To Read This Reference]
ClearHighlightedDialog |
|
Clean the highlight rectangle. | |
EnableDomains |
|
Enable searching domains. | |
GetAccessibleName |
|
Get the AccessibleName of the component, if any. | |
GetCaption |
|
Get the Caption of a component, if any. | |
GetChildCount |
|
Get the number of children, if any, for the provided container component. | |
GetChildren |
|
Get references to the children, if any, for the provided container component. | |
GetClassname |
|
Get the Classname of a component. | |
GetComponentRectangle |
|
Find the component according to Component Test Object's key and get its screen location. | |
GetId |
|
Get the ID of a component, if any. | |
GetLevel |
|
Get the Z-order of a component--usually a Window. | |
GetMatchingChildKeysAtPoint |
|
According to screen location, find the test object at that point and return all matching keys in cache. | |
GetMatchingChildObjects |
|
Retrieve an array of child objects that match a recognition string. | |
GetMatchingParentObject |
|
Get a reference to the toplevel Window\Parent that matches the recognition string provided. | |
GetMatchingPathObject |
|
Get the subitem object\node matching the provided Path. | |
GetName |
|
Get the Name (AccessibleName or Name) of the component, if any. The AccessibleName shall be found first and returned, if any. | |
GetNonAccessibleName |
|
Get the non-AccessibleName (Name except for AccessibleName) of the component, if any. | |
GetProperty |
|
Get the value of a specific property from a component. | |
GetPropertyNames |
|
Get the names of all available properties for a component. | |
GetSuperClassnames |
|
Get the hierarchy of superclasses for the component. | |
GetText |
|
Get the (text) value of a component, if any. | |
GetTopLevelCount |
|
Get the number of visible top-level items (Windows?) for the engine. | |
GetTopLevelWindows |
|
Return references to all known top-level items (Windows). | |
GetTopWindowHandle |
|
Get the Windows native handle of the top window containing the component. | |
HighlightMatchingChildObject |
|
Find the component according to Recognition String and highlight it. | |
HighlightMatchingChildObjectByKey |
|
Find the component according to Window/Component Test Object's key and highlight it. | |
IsMatchingPath |
|
Determine if there is a matching Path object. | |
IsShowing |
|
Is the component visible? | |
IsValid |
|
Does the component still exist as a valid object? | |
SetActiveWindow |
|
Make the component the active (topmost?) Window or Component. |