SAFS RobotJ Quick Reference

Last Updated:

Goto: Driver Commands, Component Functions, Engine Commands, Detailed Reference Doc


DRIVER COMMANDS

DDDriverCommands [How To Read This Reference]
AppMapChaining
SDC TID
Enable and Disable support for App Map chaining.
AppMapResolve
SDC TID
Enable and Disable support for embedded DDVariables in App Map strings.
AssignClipboardVariable
RJ TID SDC
Copy the clipboard contents to a DDVariable.
CallRemote
RJ TID SDC
Execute a command on an external system / application.
CaptureMousePositionOnScreen
RJ SDC TID
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
ClearAllVariables
RJ SDC
Clear storage of all DDVariables.
ClearAppMapCache
RJ
Clear the internal application map cache.
ClearArrayVariables
SDC
Clear storage of all SAFS variables containing a specific prefix.
ClearClipboard
RJ TID SDC
Clear the contents of the Window's clipboard.
CloseApplication
RJ TID SDC
Close a named application process launched with LaunchApplication.
CloseApplicationMap
TID
By map ID, Close a opened Application Map in map chain.
CopyVariableValueEx
RJ TID SDC
Copy the value of a (dynamic) DDVariable to another.
Delay
RJ TID SDC
Delay for a specified number of milliseconds.
DisableDomain
RJ
Disable a particular test domain for testing.
EnableDomain
RJ
Enable a particular test domain for testing.
Expressions
TID
Enable and Disable enhanced expressions.
GetAppMapValue
SDC
Assign a DDVariable a value from an App Map.
GetCompScreenResolution
RJ
Gets the current computer screen resolution and returns x and y values.
GetMillisBetweenRecords
TID
Get the pause between two records, and assigns the value to a DDVariable.
GetRegistryKeyValue
RJ SDC TID
Assign the value of the specified Registry Key to a variable.
GetSecsAfterWindowActive
RJ
Get the delay after window is activated, and assigns the value to a DDVariable.
GetSecsBeforeMouseDown
RJ
Get the delay before mouse down, and assigns the value to a DDVariable.
GetSecsBeforeMouseUp
RJ
Get the delay before mouse up, and assigns the value to a DDVariable.
GetSecsDelayRetryComponent
RJ
Get the delay of re-finding object, and assigns the value to a DDVariable.
GetSecsSeekComponent
RJ
Get the timeout of finding object, and assigns the value to a DDVariable.
GetSystemDate
RJ TID SDC
Assigns the string value of the system date to a DDVariable.
GetSystemDateTime
RJ TID SDC
Assigns the string value of the system datetime to a DDVariable.
GetSystemTime
RJ TID SDC
Assigns the string value of the current system time to a DDVariable.
GetVersion
RJ TID SDC
Get the engine VERSION
LaunchApplication
RJ TID SDC
Identify and Launch a specified application
NotifyAndWait
TID SDC
Display a user-defined message dialog and wait until dismissed.
Pause
RJ TID SDC
Pause for a specified number of seconds.
SaveClipboardToFile
RJ TID SDC
Save the clipboard contents to a text file.
ScrollWheel
RJ
Move mouse wheel forward (up) or backward (down).
SendEmail
TID
Send email notification with attachments.
SetApplicationMap
TID
Provide the Application Map for the DDE to use
SetBenchDirectory
RJ TID SDC
Set/Change the directory in which the framework will find benchmark files by default.
SetClipboard
RJ TID SDC
Set the clipboard contents to a string.
SetContext
RJ
Set a Window or Window Component as the current Robot context.
SetDifDirectory
RJ TID SDC
Set/Change the directory in which the framework will locate file compare differences.
SetFocus
RJ
Give a Window or Window Component input focus.
SetImageDebug
TID
Enable/Disable verbose debug log output and high-res failure snapshots.
SetImageFuzzyMatching
TID
Enable/Disable Image-Based Testing Fuzzy Matching.
SetMillisBetweenRecords
TID
Set the pause between two records.
SetMultipleThreadSearch
TID
Turn on or trun off the multi-thread-search way to search an image.
SetProjectDirectory
RJ TID SDC
Set/Change the framework project directory.
SetRootVerifyDirectory
RJ TID SDC
Set/Change the Bench, Test, and Dif directories to be subdirectories off of the provided path.
SetSecsAfterWindowActive
RJ
Set the delay after window is activated.
SetSecsBeforeMouseDown
RJ
Set the delay before mouse down.
SetSecsBeforeMouseUp
RJ
Set the delay before mouse up.
SetSecsDelayRetryComponent
RJ
Set the delay of re-finding object.
SetSecsSeekComponent
RJ
Set the timeout of finding object.
SetTestDirectory
RJ TID SDC
Set/Change the directory in which the framework will find test files (captured "actuals") by default.
SetVariableValueEx
RJ TID SDC
Set the value of a DDVariable
SetVariableValues
RJ TID SDC
Preset the value of one or more DDVariables
StartWebBrowser
RJ TID SDC
Launch a new web browser and optionally load a document into it.
TakeScreenShot
TID
Take screenshot and save it to a file on test machine.
UseAbbotFunctions
TID
Enable/Disable the switch to "prefer" ABBOT Functions over any other engine functions.
UseDroidFunctions
TID
Enable/Disable the switch to "prefer" Droid Functions over the current engine functions (like Robot Classic).
UseIOSFunctions
TID
Enable/Disable the switch to "prefer" IOS Functions over any other engine functions.
UseQTPFunctions
TID
Enable/Disable the switch to "prefer" QTP Functions over any other engine functions.
UseRobotJFunctions
TID
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over Robot Classic Component Functions.
UseSAFSFunctions
TID
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over the current engine functions (like Robot Classic).
UseSeleniumFunctions
TID
Enable/Disable the switch to "prefer" Selenium Functions over the current engine functions (like Robot Classic).
UseTestCompleteFunctions
TID
Enable/Disable the switch to "prefer" TestComplete (TCAFS) Functions over any other engine functions.
VerifyClipboardToFile
RJ TID SDC
Verify the current contents of the Windows clipboard with a benchmark file.
Version
TID
Specify the table format VERSION
WaitForGUI
RJ TID
Wait for a Window or Window Component to become valid.
WaitForGUIGone
RJ TID
Wait for a Window or Window Component to become invalid.
WaitForPropertyValue
RJ
Wait for a specific Window or Component property value to match an expected value.
WaitForPropertyValueGone
RJ
Wait for a specific Window or Component property value to change from a known value.
WaitForRegistryKeyExists
RJ SDC TID
Wait for a Registry Key to become valid.
WaitForRegistryKeyValue
RJ SDC TID
Wait for a specific Registry KeyValue to match an expected value.
WaitForWebPage
RJ
Wait for a web document to finish loading within a timeout period.

DDDriverCounterCommands [How To Read This Reference]
DeleteCounter
TID
Delete any existing private counter with the provided counterID.
LogCounterInfo
TID
Log the specified counter's info in the active log(s) of the current Log Facility.
ResetCounter
TID
Create a new private counter or reset counts in an existing private counter.
ResumeStatusCounts
TID
Resume counting on ALL status counters--both public/global and private.
SetCounterMode
TID
Create a new private counter or modify the mode of an existing private counter.
StartCounter
TID
Create a new private counter or start an existing stopped private counter.
StartCycle
TID
Begin tracking status on a user-defined item.
StartProcedure
TID
Begin tracking status on a user-defined item.
StartRequirement
TID
Begin tracking status on a user-defined item.
StartSuite
TID
Begin tracking status on a user-defined item.
StartTestcase
TID
Begin tracking status on a user-defined TestCase.
StopCounter
TID
Create a new private counter or suspend counts in an existing private counter.
StopCycle
TID
Stop tracking status on a user-defined item.
StopProcedure
TID
Stop tracking status on a user-defined item.
StopRequirement
TID
Stop tracking status on a user-defined item.
StopSuite
TID
Stop tracking status on a user-defined item.
StopTestcase
TID
Stop tracking status on a user-defined TestCase.
StoreCounterInfo
TID
Store the current values of the named counter into unique DDVariables.
SuspendStatusCounts
TID
Suspend counting on ALL status counters--both public/global and private.

DDDriverDatabaseCommands [How To Read This Reference]
CopyDBTableColumnToFile
RJ TID SDC
This routine will copy the contents of one or more DBTable column(s) to a file.
CopyDBTableToFile
RJ TID SDC
This routine will copy the contents of a DBTable to a file.
DeleteDBTableRecords
RJ TID SDC
Deletes records in a database table
ExecSQLQuery
RJ TID SDC
Executes the query provided in a queryStr on the database table.
GetDBTableColumnCount
RJ TID SDC
Executes the query in a specified database table and returns the total column count.
GetDBTableRowCount
RJ TID SDC
Executes the query in a database table.
GetDBValue
RJ TID SDC
Executes the query and returns the case-sensitive value as result of the execution.
SetJdbcDriver
RJ TID SDC
set Jdbc Driver
VerifyDatabaseNullValue
RJ TID SDC
Verifies the value of a field in a database table is NULL
VerifyDatabaseValue
RJ TID SDC
Verifies the case-sensitive value of a field in a database table
VerifyDBNullValue
RJ TID SDC
Verifies the value of a field in a database table is NULL
VerifyDBValue
RJ TID SDC
Verifies the case-sensitive value of a field in a database table

DDDriverDebugCommands [How To Read This Reference]
Breakpoints
RJ TID SDC
Enable and Disable Breakpoint Debugging.
CommandDebug
RJ TID SDC
Enable and Disable (C)Command Debugging.
RecordsDebug
RJ TID SDC
Enable and Disable debugging of ALL record types.
TestDebug
RJ TID SDC
Enable and Disable (T)Test Record Debugging.

DDDriverFileCommands [How To Read This Reference]
CloseFile
RJ TID SDC
Close the open file with the file number provided
CopyFile
RJ TID SDC
Copy the specified filename to the target filename.
CopyMatchingFiles
RJ TID SDC
Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
CreateDirectory
RJ TID SDC
Create the directory for the provided directory pathname
CreateFile
RJ TID SDC
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
RJ TID SDC
Delete the directory for the provided directory pathname
DeleteDirectoryContents
RJ TID SDC
Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself.
DeleteFile
RJ TID SDC
Delete the file for the file name provided
FilterImage
RJ TID SDC
Filter out specific parts of an image.
FilterTextFile
RJ TID SDC
Filter a text file based on the given parameters.
FindSqaFile
TID SDC
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
RJ TID SDC
Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
GetFileProtections
RJ TID SDC
Save the file attributes for the file name to the variable provided.
GetFiles
RJ TID SDC
Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
GetFileSize
RJ TID SDC
Determine the file size for file name provided and assign it to a DDV variable.
GetINIFileValue
RJ TID SDC
Get value from INI file.
GetStringCountInFile
RJ TID SDC
Count the number of occurrences of a target string in a File.
GetSubstringsInFile
RJ TID SDC
Extract dynamic substrings from a file using regular expressions.
GetTextFromImage
RJ SDC TID
Incorporate OCR technology to detect the text in an image file and save the text to a variable.
IfExistDir
RJ TID SDC
If the specified directory exists, then execute the following driver command.
IfExistFile
RJ TID SDC
If the specified file exists, then execute the following driver command.
IsEndOfFile
RJ TID SDC
If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
OpenFile
RJ TID SDC
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
RJ TID SDC
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
RJ TID SDC
Write output to a sequential file already opened for writing.
ReadFileChars
RJ TID SDC
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
RJ TID SDC
Read a line from the file defined by file number and assign a string containing the line read to a DDV variable.
RenameFile
RJ TID SDC
Rename the file from the old file name to the new filename
SaveTextFromImage
RJ SDC TID
Incorporate OCR technology to detect the text in an image file and save the text to a text file.
SetFileProtections
RJ TID SDC
Change the file attribute for the file name provided to the value of the new file protection provided.
WriteFileChars
RJ TID SDC
Write the specified number of characters to a file already opened for writing.

DDDriverFlowCommands [How To Read This Reference]
CallCycle
TID
Invoke a Cycle table (from StepDriver or SuiteDriver)
CallJUnit
Invoke one or more JUnit tests using the provided Class name(s).
CallScript
RJ
Invoke a custom script with passed parameters/variables, if desired.
CallStep
TID
Invoke a Step table from within another Step table (from StepDriver).
CallSuite
TID
Invoke a Suite table (from StepDriver or SuiteDriver)
ExitCycle
TID
Exit the currently running Step, Suite, and/or Cycle table.
ExitSuite
TID
Exit the currently running Step and/or Suite table.
ExitTable
TID
Exit the currently running Step, Suite, or Cycle table.
GotoBlockID
TID
Goto a named block in the current table.
OnContainsGotoBlockID
TID
Goto the named block in the current table if value2 is contained within value1.
OnDirectoryExistGotoBlockID
TID
Goto the named block in the current table if the directory exists.
OnDirectoryNotExistGotoBlockID
TID
Goto the named block in the current table if the Directory does not exist.
OnEqualGotoBlockID
TID
Goto the named block in the current table if two values are equal.
OnFileEOFGotoBlockID
RJ
Goto the named block in the current table if the file is at EOF.
OnFileExistGotoBlockID
TID
Goto the named block in the current table if the file exists.
OnFileNotExistGotoBlockID
TID
Goto the named block in the current table if the file does not exist.
OnGreaterThanGotoBlockID
TID
Goto the named block in the current table if value1 is greater than value2.
OnGUIExistsGotoBlockID
RJ TID
Goto the named block in the current table if a GUI component exists.
OnGUINotExistGotoBlockID
RJ TID
Goto the named block in the current table if a GUI component does not exist.
OnInRangeGotoBlockID
TID
Goto named block if value1 is between value2 and value3.
OnLessThanGotoBlockID
TID
Goto the named block if value1 is less than value2.
OnMenuItemContainsStateGotoBlockID
RJ
Goto the named block in the current table if state is part of the state information of the menuitem.
OnNotContainsGotoBlockID
TID
Goto the named block in the current table if value2 is NOT a substring of value1.
OnNotEqualGotoBlockID
TID
Goto the named block in the current table if two values are not equal.
OnNotGreaterThanGotoBlockID
TID
Goto the named block in the current table if value1 is NOT greater than value2.
OnNotInRangeGotoBlockID
TID
Goto the named block in the current table if value1 is not between value2 and value3.
OnNotLessThanGotoBlockID
TID
Goto the named block if value1 is NOT less than value2.
OnRegistryKeyExistGotoBlockID
TID SDC
Goto the named block in the current table if the Registry Key exists.
OnRegistryKeyNotExistGotoBlockID
TID SDC
Goto the named block in the current table if the Registry Key does not exist.
SetExitTableBlock
TID
Set or clear the name of a block to execute when the ExitTable command is encountered.
SetGeneralScriptFailureBlock
TID
Set or clear the name of a block to execute when GeneralScriptFailure occurs.
SetInvalidFileIOBlock
TID
Set or clear the name of a block to execute when InvalidFileIO occurs.
SetNoScriptFailureBlock
TID
Set or clear the name of a block to execute when NoScriptFailure occurs.
SetScriptNotExecutedBlock
TID
Set or clear the name of a block to execute when ScriptNotExecuted occurs.
SetScriptWarningBlock
TID
Set or clear the name of a block to execute when ScriptWarning occurs.
UseLocalFlowControl
TID
When TRUE then flow control block IDs have current table scope only.

DDDriverLogCommands [How To Read This Reference]
LogFailureOK
TID
Log an EXPECTED failure message.
LogMessage
TID
Log a generic message
LogTestFailure
TID
Log a FAILURE message. Also increments appropriate counters.
LogTestSuccess
TID
Log a SUCCESS/OK message. Also increments appropriate counters.
LogTestWarning
TID
Log a WARNING message. Also increments appropriate counters.
LogWarningOK
TID
Log an EXPECTED WARNING message.
ResumeLogging
TID
Resume suspended logging.
SuspendLogging
TID
Suspend all logging.

DDDriverStringCommands [How To Read This Reference]
CleanString
RJ TID SDC
CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it, otherwise turn it into a space
Compare
RJ TID SDC
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
RJ TID SDC
Concatenate String1 with String2 and returns concatenated string.
GetField
RJ TID SDC
GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
GetFieldCount
RJ TID SDC
GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
GetFixedWidthField
RJ TID SDC
GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
GetMultiDelimitedField
RJ TID SDC
Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex. The startIndex and fieldID are 1 based.
GetMultiDelimitedFieldCount
RJ TID SDC
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
RJ TID SDC
GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters. The search begins at startindex within the inputRecord.
GetREDelimitedField
RJ TID SDC
GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
GetREDelimitedFieldCount
RJ TID SDC
GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
GetSubstringsInString
RJ TID SDC
Extract dynamic substring from a string using regular expressions.
GetSystemEnviron
RJ TID SDC
GetSystemEnviron, get a system environment variable value
GetSystemUser
RJ TID SDC
Get the USERID of the currently logged on user as stored in System Environment variables.
GetTrimmedField
RJ TID SDC
GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
Index
RJ TID SDC
Returns the position of the first occurrence of one string within another string. -1 if not found at all
Left
RJ TID SDC
Returns a string of a specified number of characters copied from the beginning of another string.
LeftTrim
RJ TID SDC
A new string trimmed of leading tabs and spaces.
Length
RJ TID SDC
Returns the length of a string or variable.
Replace
RJ TID SDC
Replace 'find' substring with 'replace' substring
Right
RJ TID SDC
Returns a string of a specified number of characters copied from the end of another string.
RightTrim
RJ TID SDC
A new string trimmed of trailing tabs and spaces.
SubString
RJ TID SDC
Returns a portion of a string based on character index.
ToLowerCase
RJ TID SDC
Returns a copy of a string, with all letters converted to lowercase.
ToUpperCase
RJ TID SDC
Returns a copy of a string after converting all letters to uppercase.
Trim
RJ TID SDC
A new string trimmed of leading and trailing tabs and spaces.

DDDriverTimerCommands [How To Read This Reference]
ResetTimer
RJ TID SDC
Reset a "stopped" timer for reuse.
StartTimer
RJ TID SDC
Will start a unique timer.
StopTimer
RJ TID SDC
Will end a unique timer and perform a verify test if a value was supplied at start time.
StoreTimerInfo
RJ TID SDC
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
RJ TID SDC
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
RJ TID SDC
Well verify that a timer was in the range of the given values.
VerifyElapsedTimeIsLess
RJ TID SDC
Well verify that a timer was less then the given value.
VerifyElapsedTimeIsMore
RJ TID SDC
Well verify that a timer was greater then the given value.
VerifyTimer
RJ TID SDC
Well verify that a timer was less then the given value.


COMPONENT FUNCTIONS
(back to top)

CheckBoxFunctions [How To Read This Reference]
Check
RJ
Tries to perform a Check on the Checkbox.
UnCheck
RJ
Tries to perform a UnCheck on the Checkbox.

ComboBoxFunctions [How To Read This Reference]
CaptureItemsToFile
RJ
Capture Items To a File specified (if not abs, then to test dir)
HideList
RJ
Hide the combo box list (equivalent to an ESC or two ESCs).
Select
RJ
Select an item by its text value from a combobox.
SelectIndex
RJ
Select an item by its index from a combobox.
SelectPartialMatch
RJ
Select an item via a partial text match in a combobox.
SelectUnverified
RJ
Select an item by its text value from a combobox without verifying the selection.
SetTextValue
RJ
Set the text of the combobox
SetUnverifiedTextValue
RJ
Set the text of the combobox without verification
ShowList
RJ
Show the combo box list (expose it).
VerifySelected
RJ
Verify Selected item is equal to specified parameter

DatabaseFunctions [How To Read This Reference]
CopyDBTableColumnToFile
RJ
This routine will copy the contents of one or more DBTable column(s) to a file.
CopyDBTableToFile
RJ
This routine will copy the contents of a DBTable to a file.
DeleteDBTableRecords
RJ
Deletes records in a database table
ExecSQLCommit
RJ
This routine will commit the pending queries on the database.
ExecSQLQuery
RJ
Executes the query provided in a ^queryStr on the database table.
GetDBTableColumnCount
RJ
Executes the query in a specified database table and returns the total column count.
GetDBTableRowCount
RJ
Executes the query in a database table.
GetDBValue
RJ
Executes the query and returns the case-sensitive value as result of the execution.
VerifyDatabaseNullValue
RJ
Verifies the value of a field in a database table is NULL
VerifyDatabaseValue
RJ
Verifies the case-sensitive value of a field in a database table
VerifyDBNullValue
RJ
Verifies the value of a field in a database table is NULL
VerifyDBValue
RJ
Verifies the case-sensitive value of a field in a database table

EditBoxFunctions [How To Read This Reference]
SetTextCharacters
RJ
Set the text of the editbox
SetTextValue
RJ
Set the text of the editbox
SetUnverifiedTextCharacters
RJ
Set the text of the editbox
SetUnverifiedTextValue
RJ
Set the text of the editbox without verification

FlexColorFunctions [How To Read This Reference]
SetColor
RJ
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
RJ
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
RJ
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
RJ
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
RJ
Assign the string value of an object property to a specific DDVariable
CaptureObjectDataToFile
RJ
Copy the current contents of an object's data to a file.
CapturePropertiesToFile
RJ
Copy all of the value properties a test object to a file.
CapturePropertyToFile
RJ
Copy a propertie's value of a test object to to a file.
ClearAppMapCache
RJ
Clear the internal application map cache.
GetGUIImage
RJ TID
Capture the screen shot of a GUI component and save it to a file
GetTextFromGUI
RJ TID
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
GUIDoesExist
RJ TID
Routine to verify the visual existence of a particular window and/or component.
GUIDoesNotExist
RJ TID
Routine to verify the visual non-existence of a particular window and/or component.
HoverMouse
TID RJ
Hover the mouse over an object.
HoverScreenLocation
TID
Hover the mouse over a specified screen location.
InputCharacters
RJ TID
Sends literal text to the specified component.
InputKeys
RJ TID
Sends keystrokes to the specified component.
IsPropertyExist
RJ
Verify if object's property exists or not.
LocateScreenImage
RJ TID
Store the location and dimensions of a component.
SaveTextFromGUI
RJ TID
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
SendEvent
RJ
Send or trigger an "event" with 0 or more arguments.
SetPropertyValue
RJ
Sets a value to the property of an object.
TypeChars
TID
Sends literal text keystrokes to whatever has keyboard focus.
TypeEncryption
TID
Sends secret-text (such as password) to whatever has keyboard focus.
TypeKeys
TID
Sends keystrokes to whatever has keyboard focus.
VerifyArrayPropertyToFile
RJ
Verify the value of an array property with a benchmark file
VerifyBinaryFileToFile
RJ TID
Verify the current contents of a binary file with a benchmark file.
VerifyClipboardToFile
RJ
Verify the current contents of the Windows clipboard with a benchmark file.
VerifyFileToFile
RJ TID
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
VerifyGUIImageToFile
RJ TID
Verify the screen shot of a GUI component with a benchmark image file
VerifyObjectDataToFile
RJ
Verify the current contents of an object's data with a benchmark file.
VerifyProperty
RJ
Verify the value of a single object property
VerifyPropertyContains
RJ
Verify that the value of an object property contains a string
VerifyPropertyToFile
RJ
Verify the value of a single object property with a benchmark file
VerifyTextFileToFile
RJ TID
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
VerifyValueContains
RJ TID
Verify that a string value contains a substring
VerifyValueContainsIgnoreCase
TID
Verify that a string value contains a substring, ignoring case.
VerifyValueDoesNotContain
TID
Verify that a string value does NOT contain a substring
VerifyValues
RJ TID
Verify that two string values are identical. Note: RobotJ also uses identical keyword 'VerifyValueEquals'
VerifyValuesIgnoreCase
RJ TID
Verify that two string values are identical, ignoring case.
VerifyValuesNotEqual
TID
Verify that two string values are NOT identical.

GenericObjectFunctions [How To Read This Reference]
AltLeftDrag
RJ
An ALT left mouse drag is performed on the object based on the stored coordinates.
Click
RJ TID
A single click on an object.
ClickScreenImage
TID
Same as Click.
ClickScreenLocation
TID
Click a specified screen location.
ClickScreenPoint
TID
(Deprecated) Click a specified screen location.
CtrlAltLeftDrag
RJ
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
CtrlClick
RJ TID
A CTRL-click on an object.
CtrlClickScreenImage
TID
Same as CtrlClick.
CtrlLeftDrag
RJ
A CTRL left mouse drag is performed on the object based on the stored coordinates.
CtrlRightClick
TID RJ
A CTRL-Right click on an object.
CtrlRightClickScreenImage
TID
Same as CtrlRightClick.
CtrlShiftLeftDrag
RJ
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
DoubleClick
RJ TID
A double click on an object.
DoubleClickScreenImage
TID
Same as DoubleClick.
DoubleClickScreenLocation
TID
DoubleClick a specified screen location.
DoubleClickScreenPoint
TID
(Deprecated) DoubleClick a specified screen location.
HScrollTo
RJ
Attempts to perform an HScrollTo on an object.
LeftDrag
RJ TID
A left mouse drag is performed on the object based on the stored coordinates.
MouseClick
RJ
A single click on an object by mouse event. It uses low level mouse event to click on an object.
MultiClick
TID
Multiple clicks on an object.
MultiClickScreenImage
TID
Same as MULTICLICK.
RightClick
RJ TID
A right click on an object.
RightClickScreenImage
TID
Same as RightClick.
RightClickScreenLocation
TID
RightClick a specified screen location.
RightClickScreenPoint
TID
(Deprecated) RightClick a specified screen location.
RightDrag
RJ TID
A right mouse drag is performed on the object based on the stored coordinates.
ShiftClick
RJ TID
A SHIFT click on an object.
ShiftClickScreenImage
TID
Same as ShiftClick.
ShiftLeftDrag
RJ
A SHIFT left mouse drag is performed on the object based on the stored coordinates.
VScrollTo
RJ
Attempts to perform a VScrollTo on an object.

HTMLDocumentFunctions [How To Read This Reference]
CaptureBodySourceToFile
RJ
Captures the HTML source of the BODY tag into a file.
CaptureBodyTextToFile
RJ
Captures the visible document text into a file.
ClickLink
RJ
Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
ClickLinkBeginning
RJ
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ClickLinkContaining
RJ
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
VerifyBodySource
RJ
Compares the HTML source of the BODY tag with that of a benchmark file.
VerifyBodyText
RJ
Compares the visible doc text with that of a benchmark file.

HTMLImageFunctions [How To Read This Reference]
ClickArea
RJ
Attempts to perform a Click on a mapped region of an Image (on a webpage).
SaveHTMLImage
RJ
Attempts to Save an HTMLImage on a webpage.
VerifyHTMLImage
RJ
Attempts to verify an HTMLImage on a webpage to a benchmark file.

HTMLTableFunctions [How To Read This Reference]
ActivateCell
RJ
Attempts to perform a double click on a Table cell.
AssignCellContainsTextRow
RJ
Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRow
RJ
Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellText
RJ
Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFile
RJ
Saves a range of values to the specified file.
CaptureRangeToFile
RJ
Saves a range of values to the specified file.
ClickCell
RJ
Click on a cell specified by row and column.
DoubleClickCell
RJ
Attempts to perform a double click on a cell in a Table.
RightClickCell
RJ
Attempts to perform a right click on a cell in a Table.
SelectCell
RJ
Same as ClickCell.
SelectCellContainsTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellText
RJ
Attempts to select a particular cell.
SelectCellTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellTextSpecial
RJ
Holds down either key Control or Shift while making a cell selection with emulating either a Left or Right mouse click.
SelectFuzzyCellText
RJ
Attempts to select a particular cell.
SelectFuzzyCellTextFind
RJ
Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditable
RJ
Verifies whether the specified cell is editable.
VerifyCellText
RJ
Attempts to verify a particular cell value.
VerifyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on cell values.
VerifyCellValue
RJ
Verify the value of a specific Cell.
VerifyColumnLabel
RJ
Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellText
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on fuzzy cell values.

JavaMenuFunctions [How To Read This Reference]
SelectMenuItem
RJ
Action to select a menuItem according to its text value.
SelectMenuItemContains
RJ
Action to select a menuItem according to a partial match of its text value.
SelectUnverifiedMenuItem
RJ
Action to select a menuItem according to its text value without verification of it's existance.
VerifyMenuItem
RJ
Attempts to verify the a particular menuitem exists in a menu.
VerifyMenuItemContains
RJ
Attempts to verify the existence of a menuitem found by partial text match.

JavaTableFunctions [How To Read This Reference]
ActivateCell
RJ
Attempts to perform a double click on a JavaTable cell.
ActivateColumnLabel
RJ
Double clicks on the label of the specified column.
AssignCellContainsTextRow
RJ
Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRow
RJ
Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellText
RJ
Attempts to extract a particular cell value and assign it to the provided variable name.
AssignVariableFuzzyCellText
RJ
Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFile
RJ
Saves a range of values to the specified file.
CaptureRangeToFile
RJ
Saves a range of values to the specified file.
ClickCell
RJ
Attempts to perform a Click on a cell in a JavaTable.
ClickColumnLabel
RJ
Clicks on the label of the specified column.
DoubleClickCell
RJ
Attempts to perform a double click on a cell in a JavaTable.
DoubleClickColumnLabel
RJ
Double clicks on the label of the specified column.
RightClickCell
RJ
Attempts to perform a right click on a cell in a JavaTable.
RightClickColumnLabel
RJ
Right clicks on the label of the specified column.
SelectCell
RJ
Same as ClickCell.
SelectCellContainsTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellText
RJ
Attempts to select a particular cell.
SelectCellTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellTextSpecial
RJ
Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.
SelectFuzzyCellText
RJ
Attempts to select a particular cell.
SelectFuzzyCellTextFind
RJ
Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditable
RJ
Verifies whether the specified cell is editable.
VerifyCellText
RJ
Attempts to verify a particular cell value.
VerifyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on cell values.
VerifyColumnLabel
RJ
Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellText
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on fuzzy cell values.

JavaTreeFunctions [How To Read This Reference]
CaptureTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file.
ClickTextNode
RJ
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
RJ
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
RJ
Use CollapseTextNode instead.
CollapsePartialTextNode
RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RJ
Action to collapse a node according to its text value.
CollapseUnverifiedTextNode
RJ
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
RJ
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.
DoubleClickTextNode
RJ
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
RJ
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
RJ
Use ExpandTextNode instead.
ExpandPartialTextNode
RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RJ
Action to expand a node according to its text value.
ExpandUnverifiedTextNode
RJ
Action to blindly expand a node according to its text value.
MakeSelection
RJ
Use SelectTextNode instead.
PartialMatchTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
RightClickTextNode
RJ
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
RJ
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
RJ
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
RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartialTextNode
RJ
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
RJ
Action to select a node according to its text value.
SelectUnverifiedTextNode
RJ
Action to blindly select a node according to its text value.
SetTreeContainsNode
RJ
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RJ
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
RJ
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
VerifyTreeContainsNode
RJ
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RJ
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
RJ
Attempts to perform a double click on a DotNetTable cell.
ActivateColumnLabel
RJ
Double clicks on the label of the specified column.
AssignCellContainsTextRow
RJ
Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRow
RJ
Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellText
RJ
Attempts to extract a particular cell value and assign it to the provided variable name.
AssignVariableFuzzyCellText
RJ
Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFile
RJ
Saves a range of values to the specified file.
CaptureRangeToFile
RJ
Saves a range of values to the specified file.
ClickCell
RJ
Attempts to perform a Click on a cell in a DotNetTable.
ClickColumnLabel
RJ
Clicks on the label of the specified column.
DoubleClickCell
RJ
Attempts to perform a double click on a cell in a DotNetTable.
DoubleClickColumnLabel
RJ
Double clicks on the label of the specified column.
RightClickCell
RJ
Attempts to perform a right click on a cell in a DotNetTable.
SelectCell
RJ
Same as ClickCell.
SelectCellContainsTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellText
RJ
Attempts to select a particular cell.
SelectCellTextFind
RJ
Attempts to select a particular cell by finding the row based on cell values.
SelectCellTextSpecial
RJ
Holds down either Ctrl or Shift while making a cell selection with emulating either a Left or Right mouse click.
SelectFuzzyCellText
RJ
Attempts to select a particular cell.
SelectFuzzyCellTextFind
RJ
Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditable
RJ
Verifies whether the specified cell is editable.
VerifyCellText
RJ
Attempts to verify a particular cell value.
VerifyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on cell values.
VerifyColumnLabel
RJ
Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellText
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextContains
RJ
Attempts to verify a particular cell value.
VerifyFuzzyCellTextFind
RJ
Attempts to verify a particular cell by finding the row based on fuzzy cell values.

DotNetMenuFunctions [How To Read This Reference]
SelectMenuItem
RJ
Action to select a menuItem according to its text value.
SelectMenuItemContains
RJ
Action to select a menuItem according to a partial match of its text value.
VerifyMenuItem
RJ
Attempts to verify the a particular menuitem exists in a menu.
VerifyMenuItemContains
RJ
Attempts to verify the existence of a menuitem found by partial text match.

DotNetTreeFunctions [How To Read This Reference]
CaptureTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file.
ClickTextNode
RJ
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
RJ
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
RJ
Use CollapseTextNode instead.
CollapsePartialTextNode
RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RJ
Action to collapse a node according to its text value.
CollapseUnverifiedTextNode
RJ
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
RJ
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for Trees only.
DoubleClickTextNode
RJ
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
RJ
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
RJ
Use ExpandTextNode instead.
ExpandPartialTextNode
RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RJ
Action to expand a node according to its text value.
ExpandUnverifiedTextNode
RJ
Action to blindly expand a node according to its text value.
MakeSelection
RJ
Use SelectTextNode instead.
PartialMatchTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
RightClickTextNode
RJ
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
RJ
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
RJ
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
RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartialTextNode
RJ
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
RJ
Action to select a node according to its text value.
SelectUnverifiedTextNode
RJ
Action to blindly select a node according to its text value.
SetTreeContainsNode
RJ
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RJ
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
RJ
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for Trees only.
VerifyTreeContainsNode
RJ
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RJ
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
RJ
Routine to DblClick and Verify an item according to a partial text match.
ActivateTextItem
RJ
Routine to DblClick and Verify an item according to its text value.
ActivateUnverifiedPartialMatch
RJ
DblClicks an item according to a partial text match.
ActivateUnverifiedTextItem
RJ
Routine to DblClick an item according to its text value.
CaptureItemsToFile
RJ
Capture Items To a File specified (if not abs, then to test dir)
ClickColumnIndex
RJ
Click a column header based on it's index of list, starting from 1
ClickColumnLabel
RJ
Click a column header based on it's label
ClickTextItem
RJ
Routine to Click a selection according to its text value. Note: This keyword triggers the click event
ExtendSelectionToTextItem
RJ
Routine to Shift+Click and Verify a selection according to its text value.
RightClickTextItem
RJ
Routine to Right-Click a selection according to its text value. Note: This keyword triggers the right-click event.
SelectAnotherTextItem
RJ
Routine to Control+Click and Verify a selection according to its text value.
SelectAnotherUnverifiedTextItem
RJ
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed.
SelectIndex
RJ
Select an item based on it's index in the list, starting from 1
SelectPartialMatch
RJ
Routine to Click and Verify an item according to a partial text match.
SelectTextItem
RJ
Routine to Click and Verify a selection according to its text value.
SelectUnverifiedPartialMatch
RJ
Routine to Click an item according to a partial text match.
SelectUnverifiedTextItem
RJ
Routine to Click a selection according to its text value.
SetListContains
RJ
Set a variable with the result of checking that a listview contains the provided item.
VerifyItem
RJ
Verifies a particular case-sensitive item based on index is equal to a particular value.
VerifyItemUnselected
RJ
Verifies a particular case-sensitive text item is NOT selected.
VerifyListContains
RJ
Verifies a particular list-item exists in the list (somewhere)
VerifyListContainsPartialMatch
RJ
Verifies a particular list-item substring exists in the list (somewhere)
VerifyListDoesNotContain
RJ
Verifies a particular list-item does NOT exists in the list (somewhere)
VerifyListDoesNotContainPartialMatch
RJ
Verifies a particular list-item substring does NOT exists in the list (somewhere)
VerifyMenuItem
RJ
Verifies a particular case-sensitive menu-item exists in the list (somewhere)
VerifyMenuPartialMatch
RJ
Verifies a particular case-insensitive menu-item substring exists in the list (somewhere)
VerifyPartialMatch
RJ
Verifies a particular case-insensitive item based on index is has as substring a particular value.
VerifySelectedItem
RJ
Verifies a particular case-sensitive text item is selected
VerifySelectedPartialMatch
RJ
Verifies a particular case-sensitive item is selected based on a substring match.

PopupMenuFunctions [How To Read This Reference]
SelectPopupMenuItem
RJ
Select a menuItem via its text in the currently active popup menu.
SelectUnverifiedPopupMenuItem
RJ
Select a menuItem via its text in the currently active popup menu without verification.
VerifyPopupMenu
RJ
Verify the complete status of the current popup menu with a benchmark file.
VerifyPopupMenuItem
RJ
Verify the state of a menuItem found via its text in the currently active popup menu.
VerifyPopupMenuPartialMatch
RJ
Verify if a menuItem contains a substring

ScrollBarFunctions [How To Read This Reference]
OneDown
RJ
Attempts to perform a ScrollLineDown on a scrollbar.
OneLeft
RJ
Attempts to perform a ScrollLeft on a scrollbar.
OneRight
RJ
Attempts to perform a ScrollRight on a scrollbar.
OneUp
RJ
Attempts to perform a ScrollLineUp on a scrollbar.
PageDown
RJ
Attempts to perform a ScrollPageDown on a scrollbar.
PageLeft
RJ
Attempts to perform a ScrollPageLeft on a scrollbar.
PageRight
RJ
Attempts to perform a ScrollPageRight on a scrollbar.
PageUp
RJ
Attempts to perform a ScrollPageUp on a scrollbar.

TabControlFunctions [How To Read This Reference]
ClickTab
RJ
Attempts to perform a standard Click on a particular Tab on the TabControl
ClickTabContains
RJ
Attempts to perform a Click on a Tab according to a partial match of its text value.
MakeSelection
RJ
Attempts to perform a standard Click on a particular Tab on the TabControl
SelectTab
RJ
Attempts to perform a standard SelectTab on a particular Tab on the TabControl
SelectTabIndex
RJ
Attempts to select a particular Tab by Index.
UnverifiedClickTab
RJ
Attempts to perform an unverified Click on a particular Tab on the TabControl

ToolBarFunctions [How To Read This Reference]
ClickButtonIndex
RJ
Click on the icon at a certain position on the ToolBar object, it is 1-based.
ClickButtonText
RJ
Routine to Click on the specified Button.Key (Text) value.
ClickButtonTooltip
RJ
Click on the icon whose tooltip equals to the provided parameter
ClickUnverifiedButtonText
RJ
Routine to Click on the specified Button.Key (Text) value.

TreeViewFunctions [How To Read This Reference]
ActivateUnverifiedTextNode
RJ
Action to (almost) blindly activate (double-click) a text node.
CaptureTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file.
ClickPartial
RJ
Action to click a node according to a partial match of its text value.
ClickTextNode
RJ
Action to click a node according to its text value.
ClickUnverifiedTextNode
RJ
Action to (almost) blindly click a text node.
Collapse
RJ
Action to collapse a node according to its text value.
CollapsePartial
RJ
Action to collapse a node according to a partial match of its text value.
CollapsePartialTextNode
RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RJ
Action to collapse a node according to its text value. Use Collapse instead.
CollapseUnverifiedTextNode
RJ
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
RJ
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.
DoubleClickPartial
RJ
Action to double click a node according to a partial match of its text value.
DoubleClickTextNode
RJ
Action to double click a node according to its text value.
DoubleClickUnverifiedTextNode
RJ
Action to (almost) blindly activate (double-click) a text node.
Expand
RJ
Action to expand a node according to its text value.
ExpandPartial
RJ
Action to expand a node according to a partial match of text value.
ExpandPartialTextNode
RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RJ
Action to expand a node according to its text value. Use Expand instead.
ExpandUnverifiedTextNode
RJ
Action to blindly expand a node according to its text value.
PartialMatchTreeDataToFile
RJ
Copy the current contents of a tree[branch] to a file according to a partial match of itss text value.
RightClickPartial
RJ
Action to right click a node according to a partial match of its text value.
RightClickTextNode
RJ
Action to right click a node according to its text value.
RightClickUnverifiedTextNode
RJ
Action to (almost) blindly right-click a text node.
Select
RJ
Action to select a node according to its text value.
SelectAnotherPartialTextNode
RJ
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
RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartial
RJ
Action to select a node according to a partial match of its text value.
SelectPartialTextNode
RJ
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
RJ
Action to select a node according to its text value.
SelectUnverifiedTextNode
RJ
Action to (almost) blindly click a text node.
SetTreeContainsNode
RJ
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RJ
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
RJ
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
VerifyNodeUnselected
RJ
Action to verify a particular text node is NOT selected.
VerifySelectedNode
RJ
Action to verify a particular text node is selected.
VerifyTreeContainsNode
RJ
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RJ
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
RJ
Sends a Close command to the active window.
Maximize
RJ
Sends a WMaximize command to the active window.
Minimize
RJ
Sends a WMinimize command to the active window.
Restore
RJ
Sends a RestorePos command to the active window.
SelectMenuItem
RJ
Attempts to select a particular text string menuitem.
SelectMenuItemContains
RJ
Attempts to select a menuitem based on a partial text match.
SetPosition
RJ
Sends a SetPosition command to the window to set the position, size, and status of the window.
VerifyMenuItem
RJ
Attempts to verify the state information of a particular text string menuitem.
VerifyMenuItemContains
RJ
Attempts to verify the state information of a menuitem found by partial text match.


ENGINE COMMANDS

EngineComponentCommands [How To Read This Reference]
ClearHighlightedDialog
RJ
Clean the highlight rectangle.
EnableDomains
RJ
Enable searching domains.
GetAccessibleName
RJ
Get the AccessibleName of the component, if any.
GetCaption
RJ
Get the Caption of a component, if any.
GetChildCount
RJ
Get the number of children, if any, for the provided container component.
GetChildren
RJ
Get references to the children, if any, for the provided container component.
GetClassname
RJ
Get the Classname of a component.
GetComponentRectangle
RJ
Find the component according to Component Test Object's key and get its screen location.
GetId
RJ
Get the ID of a component, if any.
GetLevel
RJ
Get the Z-order of a component--usually a Window.
GetMatchingChildKeysAtPoint
RJ
According to screen location, find the test object at that point and return all matching keys in cache.
GetMatchingChildObjects
RJ
Retrieve an array of child objects that match a recognition string.
GetMatchingParentObject
RJ
Get a reference to the toplevel Window\Parent that matches the recognition string provided.
GetMatchingPathObject
RJ
Get the subitem object\node matching the provided Path.
GetName
RJ
Get the Name (AccessibleName or Name) of the component, if any. The AccessibleName shall be found first and returned, if any.
GetNonAccessibleName
RJ
Get the non-AccessibleName (Name except for AccessibleName) of the component, if any.
GetProperty
RJ
Get the value of a specific property from a component.
GetPropertyNames
RJ
Get the names of all available properties for a component.
GetSuperClassnames
RJ
Get the hierarchy of superclasses for the component.
GetText
RJ
Get the (text) value of a component, if any.
GetTopLevelCount
RJ
Get the number of visible top-level items (Windows?) for the engine.
GetTopLevelWindows
RJ
Return references to all known top-level items (Windows).
GetTopWindowHandle
RJ
Get the Windows native handle of the top window containing the component.
HighlightMatchingChildObject
RJ
Find the component according to Recognition String and highlight it.
HighlightMatchingChildObjectByKey
RJ
Find the component according to Window/Component Test Object's key and highlight it.
IsMatchingPath
RJ
Determine if there is a matching Path object.
IsShowing
RJ
Is the component visible?
IsValid
RJ
Does the component still exist as a valid object?
SetActiveWindow
RJ
Make the component the active (topmost?) Window or Component.


Goto: Driver Commands, Component Functions, Engine Commands, Detailed Reference Doc