SAFS Quick Reference

Last Updated:

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


DRIVER COMMANDS

DDDriverRestCommands [How To Read This Reference]
RestCleanResponseMap
TID
Delete REST response (and request if it is stored) from the internal Map.
RestDeleteResponse
TID
Delete a REST response (and request if stored) from the persistent storages.
RestDeleteResponseStore
TID
Delete ALL REST responses (and requests if stored) from the persistent storages.
RestHeadersLoad
TID
Load headers from a file.
RestStoreResponse
TID
Save a REST response into a persistent storage.
RestVerifyResponse
TID
Verify a REST response is what is expected.
RestVerifyResponseContains
TID
Verify a REST response contains what is expected.

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 SE2 DRD
Copy the clipboard contents to a DDVariable.
CallRemote
RJ TID SDC SE2
Execute a command on an external system / application.
CaptureMousePositionOnScreen
RJ SDC TID TC SE2
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
ClearAllVariables
RC RJ SDC SE2
Clear storage of all DDVariables.
ClearAppMapCache
RJ SE SE2 TC DRD
Clear the internal application map cache.
ClearArrayVariables
SDC SE2
Clear storage of all SAFS variables containing a specific prefix.
ClearClipboard
RC RJ TID SDC SE2 WR DRD
Clear the contents of the Window's clipboard.
CloseApplication
DRD RC RJ IOS TID SDC SE2 WR
Close a named application process launched with LaunchApplication.
CloseApplicationMap
TID SE2
By map ID, Close a opened Application Map in map chain.
CopyVariableValueEx
RC RJ TID SDC SE2
Copy the value of a (dynamic) DDVariable to another.
Delay
RJ TID SDC SE2
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
RC TID SE2
Enable and Disable enhanced expressions.
GetAppMapValue
SDC SE2
Assign a DDVariable a value from an App Map.
GetCompScreenResolution
RC RJ TC
Gets the current computer screen resolution and returns x and y values.
GetDeltaDate
RC TC
Calculates the delta date positive or negative delta days from the supplied date
GetMillisBetweenRecords
TID
Get the pause between two records, and assigns the value to a DDVariable.
GetRegistryKeyValue
RJ SDC TID SE2
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
RC RJ TID SDC WR SE2
Assigns the string value of the system date to a DDVariable.
GetSystemDateTime
RC RJ TID SDC WR SE2
Assigns the string value of the system datetime to a DDVariable.
GetSystemTime
RC RJ TID SDC WR SE2
Assigns the string value of the current system time to a DDVariable.
GetURL
SE2
Send an HTTP GET request, and get the response.
GetVersion
RJ TID SDC
Get the engine VERSION
HideSoftKeyboard
DRD
Hide the soft keyboard.
HighLight
TC SE2
Turn on or off the component highlight functionality.
LaunchApplication
DRD RC RJ TID IOS SDC SE2 WR
Identify and Launch a specified application
NotifyAndWait
TID SDC
Display a user-defined message dialog and wait until dismissed.
Pause
RC RJ TID SDC WR SE2
Pause for a specified number of seconds.
SaveClipboardToFile
RC RJ TID SDC DRD SE2
Save the clipboard contents to a text file.
SaveURLToFile
SE2
Send an HTTP GET request, and save the response into a file.
ScrollWheel
RJ TC SE2
Move mouse wheel forward (up) or backward (down).
SendEmail
TID SE2
Send email notification with attachments.
SetApplicationMap
RC TID WR SE2
Provide the Application Map for the DDE to use
SetBenchDirectory
RC RJ TID SDC
Set/Change the directory in which the framework will find benchmark files by default.
SetClipboard
RJ TID SDC DRD SE2
Set the clipboard contents to a string.
SetContext
RC RJ WR SE TC
Set a Window or Window Component as the current Robot context.
SetDifDirectory
RC RJ TID SDC
Set/Change the directory in which the framework will locate file compare differences.
SetFocus
RC RJ WR SE TC AUT
Give a Window or Window Component input focus.
SetImageDebug
TID SE2
Enable/Disable verbose debug log output and high-res failure snapshots.
SetImageFuzzyMatching
TID SE2
Enable/Disable Image-Based Testing Fuzzy Matching.
SetMillisBetweenRecords
TID
Set the pause between two records.
SetMultipleThreadSearch
TID SE2
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
RC 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
RC RJ TID SDC
Set/Change the directory in which the framework will find test files (captured "actuals") by default.
SetVariableValueEx
RC RJ TID SDC SE2
Set the value of a DDVariable
SetVariableValues
RC RJ TID SDC WR SE2
Preset the value of one or more DDVariables
ShowSoftKeyboard
DRD
Show the soft keyboard.
StartWebBrowser
RC RJ TID SDC WR SE SE2
Launch a new web browser and optionally load a document into it.
StopWebBrowser
SE2
Stop an opened web browser indicated by ID.
SwitchWindow
SE2
Switch between multiple windows according to its title.
TakeScreenShot
DRD TID SE2
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
RC TID
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over Robot Classic Component Functions.
UseSAFSFunctions
RC TID
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over the current engine functions (like Robot Classic).
UseSeleniumFunctions
RC 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.
UseWebBrowser
SE2
Switch to use an opened web browser indicated by ID.
VerifyClipboardToFile
RJ TID SDC DRD SE2
Verify the current contents of the Windows clipboard with a benchmark file.
VerifyURLContent
SE2
Send an HTTP GET request, and verify the response with the content provided as parameter.
VerifyURLToFile
SE2
Send an HTTP GET request, and verify the response with the content of a file.
Version
RC TID WR
Specify the table format VERSION
WaitForGUI
DRD RC RJ TID WR SE SE2 TC AUT
Wait for a Window or Window Component to become valid.
WaitForGUIGone
DRD RC RJ TID WR TC SE2 AUT
Wait for a Window or Window Component to become invalid.
WaitForPropertyValue
RC RJ WR TC
Wait for a specific Window or Component property value to match an expected value.
WaitForPropertyValueGone
RC RJ WR TC
Wait for a specific Window or Component property value to change from a known value.
WaitForRegistryKeyExists
RJ SDC TID SE2
Wait for a Registry Key to become valid.
WaitForRegistryKeyValue
RJ SDC TID SE2
Wait for a specific Registry KeyValue to match an expected value.
WaitForWebPage
RC RJ WR SE
Wait for a web document to finish loading within a timeout period.

DDDriverCounterCommands [How To Read This Reference]
DeleteCounter
RC TID WR
Delete any existing private counter with the provided counterID.
LogCounterInfo
RC TID WR SE2
Log the specified counter's info in the active log(s) of the current Log Facility.
ResetCounter
RC TID WR
Create a new private counter or reset counts in an existing private counter.
ResumeStatusCounts
RC TID WR SE2
Resume counting on ALL status counters--both public/global and private.
SetCounterMode
RC TID WR
Create a new private counter or modify the mode of an existing private counter.
StartCounter
RC TID WR SE2
Create a new private counter or start an existing stopped private counter.
StartCycle
RC TID WR
Begin tracking status on a user-defined item.
StartProcedure
RC TID WR
Begin tracking status on a user-defined item.
StartRequirement
RC TID WR
Begin tracking status on a user-defined item.
StartSuite
RC TID WR SE2
Begin tracking status on a user-defined item.
StartTestcase
RC TID WR SE2
Begin tracking status on a user-defined TestCase.
StopCounter
RC TID WR SE2
Create a new private counter or suspend counts in an existing private counter.
StopCycle
RC TID WR
Stop tracking status on a user-defined item.
StopProcedure
RC TID WR
Stop tracking status on a user-defined item.
StopRequirement
RC TID WR
Stop tracking status on a user-defined item.
StopSuite
RC TID WR
Stop tracking status on a user-defined item.
StopTestcase
RC TID WR SE2
Stop tracking status on a user-defined TestCase.
StoreCounterInfo
RC TID WR SE2
Store the current values of the named counter into unique DDVariables.
SuspendStatusCounts
RC TID WR SE2
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
RC RJ TID SDC WR
Enable and Disable Breakpoint Debugging.
CommandDebug
RC RJ TID SDC WR
Enable and Disable (C)Command Debugging.
RecordsDebug
RC RJ TID SDC WR
Enable and Disable debugging of ALL record types.
TestDebug
RC RJ TID SDC WR
Enable and Disable (T)Test Record Debugging.

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

DDDriverFlowCommands [How To Read This Reference]
CallCycle
RC TID WR
Invoke a Cycle table (from StepDriver or SuiteDriver)
CallJUnit
TID
Invoke one or more JUnit tests using the provided Class name(s).
CallScript
SE2 RC IOS RJ WR
Invoke a custom script with passed parameters/variables, if desired.
CallStep
RC TID WR
Invoke a Step table from within another Step table (from StepDriver).
CallSuite
RC TID WR
Invoke a Suite table (from StepDriver or SuiteDriver)
ExitCycle
RC TID WR
Exit the currently running Step, Suite, and/or Cycle table.
ExitSuite
RC TID WR
Exit the currently running Step and/or Suite table.
ExitTable
RC TID WR
Exit the currently running Step, Suite, or Cycle table.
GotoBlockID
RC TID WR
Goto a named block in the current table.
OnContainsGotoBlockID
RC TID WR
Goto the named block in the current table if value2 is contained within value1.
OnDirectoryExistGotoBlockID
RC WR TID
Goto the named block in the current table if the directory exists.
OnDirectoryNotExistGotoBlockID
RC WR TID
Goto the named block in the current table if the Directory does not exist.
OnEqualGotoBlockID
RC TID WR
Goto the named block in the current table if two values are equal.
OnFileEOFGotoBlockID
RC RJ
Goto the named block in the current table if the file is at EOF.
OnFileExistGotoBlockID
RC WR TID
Goto the named block in the current table if the file exists.
OnFileNotExistGotoBlockID
RC WR TID
Goto the named block in the current table if the file does not exist.
OnGreaterThanGotoBlockID
RC TID WR
Goto the named block in the current table if value1 is greater than value2.
OnGUIExistsGotoBlockID
DRD IOS RC RJ TID WR SE SE2 TC
Goto the named block in the current table if a GUI component exists.
OnGUINotExistGotoBlockID
DRD IOS RC RJ TID WR SE SE2 TC
Goto the named block in the current table if a GUI component does not exist.
OnInRangeGotoBlockID
RC TID WR
Goto named block if value1 is between value2 and value3.
OnLessThanGotoBlockID
RC TID WR
Goto the named block if value1 is less than value2.
OnMenuItemContainsStateGotoBlockID
RC RJ
Goto the named block in the current table if state is part of the state information of the menuitem.
OnNotContainsGotoBlockID
TID RC
Goto the named block in the current table if value2 is NOT a substring of value1.
OnNotEqualGotoBlockID
RC TID WR
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
RC TID WR
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.
OnPartialMenuItemContainsStateGotoBlockID
RC
Goto the named block in the current table if state is part of the state information of the menuitem. This command allows for a partial match of the menu item.
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
RC TID WR
Set or clear the name of a block to execute when the ExitTable command is encountered.
SetGeneralScriptFailureBlock
RC TID WR
Set or clear the name of a block to execute when GeneralScriptFailure occurs.
SetInvalidFileIOBlock
RC TID WR
Set or clear the name of a block to execute when InvalidFileIO occurs.
SetNoScriptFailureBlock
RC TID WR
Set or clear the name of a block to execute when NoScriptFailure occurs.
SetScriptNotExecutedBlock
RC TID WR
Set or clear the name of a block to execute when ScriptNotExecuted occurs.
SetScriptWarningBlock
RC TID WR
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
RC WR TID
Log an EXPECTED failure message.
LogMessage
RC WR TID SE2
Log a generic message
LogTestFailure
RC WR TID SE2
Log a FAILURE message. Also increments appropriate counters.
LogTestSuccess
RC WR TID SE2
Log a SUCCESS/OK message. Also increments appropriate counters.
LogTestWarning
RC WR TID SE2
Log a WARNING message. Also increments appropriate counters.
LogWarningOK
RC WR TID
Log an EXPECTED WARNING message.
ResumeLogging
RC TID SE2
Resume suspended logging.
SuspendLogging
RC TID SE2
Suspend all logging.

DDDriverStringCommands [How To Read This Reference]
CleanString
RJ TID SDC RC SE2
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 SE2
Compares two strings and returns an integer specifying the result of the comparison. The java version returns 'true' or 'false' as the result.
Concatenate
RJ TID SDC RC SE2
Concatenate String1 with String2 and returns concatenated string.
GetField
RC RJ TID SDC SE2
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 RC SE2
GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
GetFixedWidthField
RJ TID SDC RC SE2
GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
GetMultiDelimitedField
RJ TID SDC RC SE2
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 RC SE2
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 RC SE2
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 SE2
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 SE2
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 SE2
Extract dynamic substring from a string using regular expressions.
GetSystemEnviron
RJ RC TID SDC SE2
GetSystemEnviron, get a system environment variable value
GetSystemUser
RJ TID SDC RC SE2
Get the USERID of the currently logged on user as stored in System Environment variables.
GetTrimmedField
RJ TID SDC RC SE2
GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
Index
RJ TID SDC RC SE2
Returns the position of the first occurrence of one string within another string. -1 if not found at all
Left
RJ TID SDC RC SE2
Returns a string of a specified number of characters copied from the beginning of another string.
LeftTrim
RJ TID SDC RC SE2
A new string trimmed of leading tabs and spaces.
Length
RJ TID SDC RC SE2
Returns the length of a string or variable.
Replace
RJ TID SDC RC SE2
Replace 'find' substring with 'replace' substring
Right
RJ TID SDC RC SE2
Returns a string of a specified number of characters copied from the end of another string.
RightTrim
RJ TID SDC RC SE2
A new string trimmed of trailing tabs and spaces.
SubString
RJ TID SDC RC SE2
Returns a portion of a string based on character index.
ToLowerCase
RJ TID SDC RC SE2
Returns a copy of a string, with all letters converted to lowercase.
ToUpperCase
RJ TID SDC RC SE2
Returns a copy of a string after converting all letters to uppercase.
Trim
RJ TID SDC RC SE2
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.

DDDriverDeprecatedCommands [How To Read This Reference]
EndRequirement
RC WR
DEPRECATED. Use StopRequirement instead.
EndTestcase
RC WR
DEPRECATED. Use StopTestCase instead.
GetVariableValueEx
RC WR
Replaced by CopyVariableValueEx
SetRequirement
RC WR
DEPRECATED. Use StartRequirement instead.
SetTestcase
RC WR
DEPRECATED. Use StartTestCase instead.


COMPONENT FUNCTIONS
(back to top)

CheckBoxFunctions [How To Read This Reference]
Check
RC RJ WR SE SE2 TC DRD
Tries to perform a Check on the Checkbox.
Click
WR
Use Generic Object Click
UnCheck
RC RJ WR SE SE2 TC DRD
Tries to perform a UnCheck on the Checkbox.

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

ComboEditBoxFunctions [How To Read This Reference]
Click
WR TC
Defaults to Generic CLICK where applicable.
Select
RC WR TC
Select an item by its text value from a ComboEditBox.
SelectIndex
RC WR TC
Select an item by its index from a ComboEditBox (ComboBox).
SelectPartialMatch
RC WR TC
Select an item via a partial text match.
SetTextValue
RC WR TC
Set the text of the ComboEditBox
SetUnverifiedTextValue
RC TC
Set the text of the ComboEditBox without verification

ComboListBoxFunctions [How To Read This Reference]
Select
RC WR TC
Select an item by its text value from an exposed combobox dropdown list.
SelectIndex
RC WR TC
Select an item by its index from a combolistbox.

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

DatePickerFunctions [How To Read This Reference]
GetDate
DRD
Action to get date from a date picker component and assign it to a variable.
SetDate
DRD
Action to set date for a date picker component according to its DateValue.

EditBoxFunctions [How To Read This Reference]
SetTextCharacters
DRD RC RJ WR TC SE SE2
Set the text of the editbox
SetTextValue
RC RJ WR TC SE SE2 DRD AUT
Set the text of the editbox
SetUnverifiedTextCharacters
DRD RC RJ WR TC SE SE2
Set the text of the editbox
SetUnverifiedTextValue
RC RJ WR TC SE SE2 DRD
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
RC IOS RJ WR SE SE2 TC
Assign the string value of an object property to a specific DDVariable
CaptureObjectDataToFile
RC TC RJ SE SE2
Copy the current contents of an object's data to a file.
CapturePropertiesToFile
RJ IOS SE SE2 TC DRD
Copy all of the value properties a test object to a file.
CapturePropertyToFile
RJ IOS SE SE2 TC
Copy a propertie's value of a test object to to a file.
ClearAppMapCache
RJ SE2
Clear the internal application map cache.
ClearCache
SE2
Clear the cache of a component.
ExecuteScript
SE2
Execute a piece of script on the specified component synchronously.
GetComputedStyle
SE2
Get a component's 'computed style', and save them to a file.
GetGUIImage
DRD RC RJ IOS TID SE SE2 TC AUT
Capture the screen shot of a GUI component and save it to a file
GetTextFromGUI
RJ TID SE SE2
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
GUIDoesExist
DRD IOS RC RJ TID WR SE SE2 TC
Routine to verify the visual existence of a particular window and/or component.
GUIDoesNotExist
DRD IOS RC RJ TID WR SE SE2 TC
Routine to verify the visual non-existence of a particular window and/or component.
HoverMouse
RC TID RJ TC SE SE2 AUT
Hover the mouse over an object.
HoverScreenLocation
TID
Hover the mouse over a specified screen location.
InputCharacters
RC DRD IOS RJ TID WR ABT SE SE2
Sends literal text to the specified component.
InputKeys
RC RJ TID WR ABT SE SE2 TC DRD
Sends keystrokes to the specified component.
IsPropertyExist
RJ TC SE SE2
Verify if object's property exists or not.
LocateScreenImage
RJ TID TC SE SE2
Store the location and dimensions of a component.
SaveTextFromGUI
RJ TID SE SE2
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
SendEvent
RJ TC
Send or trigger an "event" with 0 or more arguments.
SetPropertyValue
RC RJ TC
Sets a value to the property of an object.
ShowOnPage
SE2
Make the component visible on the page.
TypeChars
TID DRD SE2
Sends literal text keystrokes to whatever has keyboard focus.
TypeEncryption
TID
Sends secret-text (such as password) to whatever has keyboard focus.
TypeKeys
TID DRD SE2
Sends keystrokes to whatever has keyboard focus.
VerifyArrayPropertyToFile
RC RJ WR
Verify the value of an array property with a benchmark file
VerifyBinaryFileToFile
RC RJ TID TC
Verify the current contents of a binary file with a benchmark file.
VerifyClipboardToFile
RC RJ WR TC
Verify the current contents of the Windows clipboard with a benchmark file.
VerifyClipboardVP
RC WR
Verify the current contents of the Windows clipboard using a Robot ClipboardVP.
VerifyComputedStyle
SE2
Verify a component's 'computed style' against a benchmark file.
VerifyFileToFile
RC RJ TID TC
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
VerifyGUIImageToFile
RC RJ IOS TID SE SE2 TC
Verify the screen shot of a GUI component with a benchmark image file
VerifyObjectDataToFile
RC RJ SE SE2
Verify the current contents of an object's data with a benchmark file.
VerifyPropertiesSubsetToFile
SE SE2
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
VerifyPropertiesToFile
IOS DRD SE SE2
Compare/Verify ALL of the value properties of a test object with a benchmark file.
VerifyProperty
RC RJ IOS WR SE SE2 TC
Verify the value of a single object property
VerifyPropertyContains
RC RJ IOS WR SE SE2 TC
Verify that the value of an object property contains a string
VerifyPropertyToFile
RC IOS RJ WR TC SE SE2
Verify the value of a single object property with a benchmark file
VerifyTabOrder
RC WR
Attempts to verify the tab order of the specified object--usually a Window.
VerifyTextFileToFile
RC RJ TID TC
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
VerifyValueContains
RC RJ TID WR TC
Verify that a string value contains a substring
VerifyValueContainsIgnoreCase
TC TID
Verify that a string value contains a substring, ignoring case.
VerifyValueDoesNotContain
TID
Verify that a string value does NOT contain a substring
VerifyValues
RC RJ TID WR TC
Verify that two string values are identical. Note: RobotJ also uses identical keyword 'VerifyValueEquals'
VerifyValuesIgnoreCase
RC RJ TID WR TC
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 TC SE2
An ALT left mouse drag is performed on the object based on the stored coordinates.
Click
DRD RC RJ IOS TID WR TC ABT SE SE2 AUT
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.
CompareStoredData
RC
Performs a GenericObjectVP CompareData on an object.
CompareStoredProperties
RC WR
Performs a GenericObjectVP CompareProperties on an object.
CtrlAltLeftDrag
RJ TC SE2
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
CtrlClick
RC RJ WR TID TC ABT SE SE2 AUT
A CTRL-click on an object.
CtrlClickScreenImage
TID
Same as CtrlClick.
CtrlLeftDrag
RJ TC SE2
A CTRL left mouse drag is performed on the object based on the stored coordinates.
CtrlRightClick
RC TID RJ SE SE2
A CTRL-Right click on an object.
CtrlRightClickScreenImage
TID
Same as CtrlRightClick.
CtrlShiftLeftDrag
RJ TC SE2
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
DoubleClick
RC RJ IOS TID TC WR ABT SE SE2 AUT
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.
DoubleTap
IOS
A double-tap on a touchscreen object. Use keyword "DoubleClick" syntax and parameters.
DragTo
TC SE2
A left mouse drag is performed from one object to another object based on the offsets values.
Flick
IOS
A user-defined flick or swipe on a touchscreen object.
FlickDown
IOS
A flick or swipe on a touchscreen object from top-to-bottom.
FlickLeft
IOS
A flick or swipe on a touchscreen object from right-to-left.
FlickRight
IOS
A flick or swipe on a touchscreen object from left-to-right.
FlickUp
IOS
A flick or swipe on a touchscreen object from bottom-to-top.
HScrollTo
RC RJ TC
Attempts to perform an HScrollTo on an object.
JavaMenuSelect
RC WR
Select a JAVA Menu Item according to a stored text value.
LeftDrag
RC RJ TID TC WR SE2
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.
Press
DRD IOS
Press a touchscreen object for a number of seconds--0 seconds by default.
RightClick
RC RJ TID TC WR ABT SE SE2 AUT
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
RC RJ TID WR TC SE2
A right mouse drag is performed on the object based on the stored coordinates.
ShiftClick
RC RJ TID TC WR ABT SE SE2 AUT
A SHIFT click on an object.
ShiftClickScreenImage
TID
Same as ShiftClick.
ShiftLeftDrag
RJ TC SE2
A SHIFT left mouse drag is performed on the object based on the stored coordinates.
Tap
DRD IOS
A single Tap on a touchscreen object. Use keyword "Click" syntax and parameters.
TwoFingerTap
IOS
A two-finger tap on a touchscreen object.
VerifyImage
RC
Performs a GenericObjectVP CompareImage OR a RegionImageVP on an object.
VScrollTo
RC RJ TC
Attempts to perform a VScrollTo on an object.

GraphicControlFunctions [How To Read This Reference]
Click
WR
Attempts to perform a standard Click on the GraphicControl object
ClickButton
RC WR
Attempts to perform a standard Click on the GraphicControl object

HTMLFunctions [How To Read This Reference]

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

HTMLImageFunctions [How To Read This Reference]
Click
WR
Command deprecated in favor of ClickArea.
ClickArea
RJ
Attempts to perform a Click on a mapped region of an Image (on a webpage).
CompareStoredData
WR
Performs a HTMLImageVP CompareData on an HTMLImage object.
CompareStoredProperties
WR
Performs a HTMLImageVP CompareProperties on an HTMLImage object.
SaveHTMLImage
RC RJ
Attempts to Save an HTMLImage on a webpage.
VerifyHTMLImage
RC RJ
Attempts to verify an HTMLImage on a webpage to a benchmark file.

HTMLLinkFunctions [How To Read This Reference]
Click
WR
Use Generic CLICK where possible.
CompareStoredData
WR
Performs a HTMLLinkVP CompareData on an HTMLLink object.
CompareStoredProperties
WR
Performs a HTMLLinkVP CompareProperties on an HTMLLink object.

HTMLTableFunctions [How To Read This Reference]
ActivateCell
RJ SE
Attempts to perform a double click on a Table cell.
AssignCellContainsTextRow
RJ SE
Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRow
RJ SE
Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellText
RJ SE
Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFile
RJ SE
Saves a range of values to the specified file.
CaptureRangeToFile
RJ SE
Saves a range of values to the specified file.
Click
WR
Attempts to perform a standard Click on an HTMLTable on a webpage.
ClickCell
RC RJ WR SE
Click on a cell specified by row and column.
CompareStoredData
WR
Performs a HTMLTableVP CompareData on an HTMLTable object.
CompareStoredProperties
WR
Performs a HTMLTableVP CompareProperties on an HTMLTable object.
DoubleClickCell
RJ SE
Attempts to perform a double click on a cell in a Table.
RightClickCell
RJ SE
Attempts to perform a right click on a cell in a Table.
SelectCell
RJ SE
Same as ClickCell.
SelectCellContainsTextFind
RJ SE
Attempts to select a particular cell by finding the row based on cell values.
SelectCellText
RJ SE
Attempts to select a particular cell.
SelectCellTextFind
RJ SE
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 SE
Attempts to select a particular cell.
SelectFuzzyCellTextFind
RJ SE
Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditable
RJ SE
Verifies whether the specified cell is editable.
VerifyCellText
RJ SE
Attempts to verify a particular cell value.
VerifyCellTextContains
RJ SE
Attempts to verify a particular cell value.
VerifyCellTextFind
RJ SE
Attempts to verify a particular cell by finding the row based on cell values.
VerifyCellValue
RJ WR SE
Verify the value of a specific Cell.
VerifyColumnLabel
RJ SE
Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellText
RJ SE
Attempts to verify a particular cell value.
VerifyFuzzyCellTextContains
RJ SE
Attempts to verify a particular cell value.
VerifyFuzzyCellTextFind
RJ SE
Attempts to verify a particular cell by finding the row based on fuzzy cell values.

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

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

JavaTreeFunctions [How To Read This Reference]
CaptureTreeDataToFile
RC RJ
Copy the current contents of a tree[branch] to a file.
ClickTextNode
RC 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
RC 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
RC RJ
Use CollapseTextNode instead.
CollapsePartialTextNode
RC RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RC RJ
Action to collapse a node according to its text value.
CollapseUnverifiedTextNode
RC 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
RC 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
RC 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
RC RJ
Use ExpandTextNode instead.
ExpandPartialTextNode
RC RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RC RJ
Action to expand a node according to its text value.
ExpandUnverifiedTextNode
RC RJ
Action to blindly expand a node according to its text value.
MakeSelection
RC RJ
Use SelectTextNode instead.
PartialMatchTreeDataToFile
RC RJ
Copy the current contents of a tree[branch] to a file according to a partial match of its text value.
RightClickTextNode
RC 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
RC 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
RC 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
RC RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RC RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartialTextNode
RC 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
RC RJ
Action to select a node according to its text value.
SelectUnverifiedTextNode
RC RJ
Action to blindly select a node according to its text value.
SetTreeContainsNode
RC RJ
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RC 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
RC RJ
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RC 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.

LabelFunctions [How To Read This Reference]
Click
WR
Attempts to perform a standard Click on the Label

ListBoxFunctions [How To Read This Reference]
ActivatePartialMatch
RC RJ WR SE
Routine to DblClick and Verify an item according to a partial text match.
ActivateTextItem
RC RJ WR SE
Routine to DblClick and Verify an item according to its text value.
ActivateUnverifiedPartialMatch
RC RJ SE
DblClicks an item according to a partial text match.
ActivateUnverifiedTextItem
RC RJ SE
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
RC RJ SE
Routine to Control+Click and Verify a selection according to its text value.
SelectAnotherUnverifiedTextItem
RC RJ SE
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed.
SelectIndex
RJ SE
Select an item based on it's index in the list, starting from 1
SelectPartialMatch
RC RJ WR SE
Routine to Click and Verify an item according to a partial text match.
SelectTextItem
RC RJ WR SE
Routine to Click and Verify a selection according to its text value.
SelectUnverifiedAnotherTextItem
RC
Use the identical "SelectAnotherUnverifiedTextItem" instead.
SelectUnverifiedPartialMatch
RC RJ SE
Routine to Click an item according to a partial text match.
SelectUnverifiedTextItem
RC RJ SE
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
RC RJ WR SE
Verifies a particular case-sensitive text item is NOT selected.
VerifyListContains
RC RJ WR SE
Verifies a particular list-item exists in the list (somewhere)
VerifyListContainsPartialMatch
RC RJ SE
Verifies a particular list-item substring exists in the list (somewhere)
VerifyListDoesNotContain
RC RJ WR SE
Verifies a particular list-item does NOT exists in the list (somewhere)
VerifyListDoesNotContainPartialMatch
RC RJ SE
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
RC RJ WR SE
Verifies a particular case-sensitive text item is selected
VerifySelectedPartialMatch
RC RJ WR SE
Verifies a particular case-sensitive item is selected based on a substring match.

ListViewFunctions [How To Read This Reference]
ActivateIndex
DRD SE2
Activate (double-click) an item based on it's index in the list
ActivateIndexItem
DRD SE2
Routine to double click an item according to its index in the list.
ActivatePartialMatch
TC DRD SE2
Routine to double click an item according to a partial text match.
ActivateTextItem
RC WR TC DRD SE2
Routine to double click an item according to its text value.
ActivateTextItemCoords
RC SE2
Double click a text item at specific Coords.
ActivateUnverifiedTextItem
RC TC DRD SE2
Routine to double click an unverifiable item according to its text value.
ActivateUnverifiedTextItemCoords
RC SE2
Double click an unverifiable text item at specific Coords.
AssignCellValue
RC
Assigns the value of a cell in a listview to a variable.
CaptureItemsToFile
DRD TC SE2
Capture Items To a File specified (if not abs, then to test dir)
ClickIndex
DRD SE2
Same as (Alias for) ListView ActivateIndexItem
ClickIndexItem
DRD SE2
Same as (Alias for) ListView ActivateIndexItem
ExtendSelectionToTextItem
TC SE2
Routine to Shift+Click and Verify a selection according to its text value.
RightClickTextItem
RC TC SE2
Routine to RightClick (single click) an item according to its text value.
RightClickTextItemCoords
RC SE2
Right click a text item at specific Coords.
RightClickUnverifiedTextItem
RC
Routine to RightClick (single click) an unverifiable item according to its text value.
RightClickUnverifiedTextItemCoords
RC
Right Click an unverifiable text item at specific Coords.
SelectAnotherPartialMatch
TC SE2
Routine for multiple selection to Control+Click on an item according to a partial text match.
SelectAnotherTextItem
TC SE2
Routine for multiple selection to Control+Click on an item by its text value.
SelectIndex
DRD SE2
Same as (Alias for) ListView SelectIndexItem
SelectIndexItem
RC WR TC DRD SE2
Routine to single click an item according to its Index value.
SelectIndexItemCoords
RC SE2
Routine to single click an item by Index at specific coordinates.
SelectPartialMatch
TC DRD SE2
Routine to select (single click) an item according to a partial text match.
SelectRandomItems
RC WR
Routine to randomly select multiple items in the ListView object.
SelectTextItem
RC WR TC DRD SE2
Routine to select (single click) an item according to its text value.
SelectTextItemCoords
RC SE2
Single click a text item at specific Coords.
SelectUnverifiedTextItem
RC TC DRD SE2
Routine to select (single click) an unverifiable item according to its text value.
SelectUnverifiedTextItemCoords
RC SE2
Single click an unverifiable text item at specific Coords.
SetListContains
RC TC SE2
Set a variable with the result of checking that a listview contains the provided item.
VerifyItemUnselected
RC WR TC SE2
Verifies a particular case-sensitive text item is NOT selected.
VerifyListContains
RC TC SE2
Verify that a list view contains the provided item.
VerifySelectedItem
RC WR TC SE2
Verifies a particular case-sensitive text item is selected

PopupMenuFunctions [How To Read This Reference]
SelectPopupMenuID
RC
Select a menuItem via its menuID in the currently active popup menu.
SelectPopupMenuItem
RC RJ TC
Select a menuItem via its text in the currently active popup menu.
SelectUnverifiedPopupMenuItem
RC RJ TC
Select a menuItem via its text in the currently active popup menu without verification.
VerifyPopupMenu
RC RJ
Verify the complete status of the current popup menu with a benchmark file.
VerifyPopupMenuID
RC
Verify the state of a menuItem via its menuID in the currently active popup menu.
VerifyPopupMenuItem
RC 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

ProgressBarFunctions [How To Read This Reference]
GetProgress
DRD
Action to get progress of a progress bar component.
GetRating
DRD
Action to get rating of a rating bar component.Note: Work ONLY for android.widget.RatingBar object.
SetProgress
DRD
Action to set progress for a progress bar component according to its value.
SetRating
DRD
Action to set rating for a rating bar component according to its value.Note: Work ONLY for android.widget.RatingBar object.

PushButtonFunctions [How To Read This Reference]
Click
WR TC
Attempts to perform a standard Click on the PushButton
ClickButton
RC WR TC
Attempts to perform a standard Click on the PushButton

RadioButtonFunctions [How To Read This Reference]
Click
WR TC
Attempts to perform a standard Click on the RadioButton

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

SSTreeFunctions [How To Read This Reference]
CollapseNode
RC WR
Routine to DblClick a node according to its AppMap reference.
ExpandNode
RC WR
Routine to DblClick a node according to its AppMap reference.
SelectNode
RC WR
Routine to select a node according to its AppMap reference.
VerifyExpandedState
RC WR
Routine to verify the state of the Expanded property--True or False-- for the node with the provided text.
VerifySelectedText
RC WR
Routine to verify the text of the currently selected node.

FPSpreadFunctions [How To Read This Reference]
CaptureRangeToFile
RC
Capture the grid data to the specified file. For now, it can only be used to capture all of the grid data.
ClickCell
RC
Attempts to perform a single click on a table cell.
CtrlClickCell
RC
Attempts to perform a single Ctrl+Click on a table cell.
DoubleClickCell
RC
Attempts to perform a double click on a table cell.
FindRowNumber
RC
Search specified columns for the specified text. Assign the matching row number to the given variable.
RightClickCell
RC
Attempts to perform a single right click on a table cell.
ShiftClickCell
RC
Attempts to perform a single SHIFT+Click on a table cell.
VerifyCellText
RC
Verify a specific cell's text.

TabControlFunctions [How To Read This Reference]
Click
WR
Use ClickTab instead (where available).
ClickTab
RC RJ WR TC DRD SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
ClickTabContains
RJ TC DRD SE2
Attempts to perform a Click on a Tab according to a partial match of its text value.
MakeSelection
RC RJ WR TC DRD SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
SelectTab
RC RJ WR TC DRD SE2
Attempts to perform a standard SelectTab on a particular Tab on the TabControl
SelectTabIndex
RC RJ TC DRD SE2
Attempts to select a particular Tab by Index.
UnverifiedClick
WR
Use UnverifiedClickTab instead (where available).
UnverifiedClickTab
RC RJ TC DRD SE2
Attempts to perform an unverified Click on a particular Tab on the TabControl

TableViewFunctions [How To Read This Reference]
ActivateTableRow
WR
Activate the specified row in the table.
GetCellValue
WR
Get the value of a cell at a certain row and column
GetRowCount
WR
Get a count of how many rows are in the table
SetSelectedColumn
WR
Set the current column of to the one specified.
SetSelectedRow
WR
Set the current row of to the one specified.
SetTableCellData
WR
Set a specific cell to the specified value.
VerifyCellValue
WR
Verify the contents of a particular cell at position row, column.

TimePickerFunctions [How To Read This Reference]
GetTime
DRD
Action to get time from a time picker component and assign it to a variable.
SetTime
DRD
Action to set time for a time picker component according to its TimeValue.

TIDRestFunctions [How To Read This Reference]
RestDeleteBinary
RestDeleteCSS
RestDeleteCustom
TID
Perform the "DELETE" method on a REST service with headers defined by user.
RestDeleteHTML
RestDeleteImage
RestDeleteJSON
RestDeleteScript
RestDeleteText
RestDeleteXML
RestEndServiceSession
TID
Stop a session for a REST service.
RestGetBinary
TID
Perform the "GET" method on a REST service, and try to get back the binary content.
RestGetCSS
TID
Perform the "GET" method on a REST service, and try to get back the css text content.
RestGetCustom
TID
Perform the "GET" method on a REST service with headers defined by user.
RestGetHTML
TID
Perform the "GET" method on a REST service, and try to get back the html text content.
RestGetImage
TID
Perform the "GET" method on a REST service, and try to get back the image content.
RestGetJSON
TID
Perform the "GET" method on a REST service, and try to get back the json text content.
RestGetScript
TID
Perform the "GET" method on a REST service, and try to get back the javascript text content.
RestGetText
TID
Perform the "GET" method on a REST service, and try to get back the plain text content.
RestGetXML
TID
Perform the "GET" method on a REST service, and try to get back the xml text content.
RestHeadBinary
RestHeadCSS
RestHeadCustom
RestHeadHTML
RestHeadImage
RestHeadJSON
RestHeadScript
RestHeadText
RestHeadXML
RestPatchBinary
RestPatchCSS
RestPatchCustom
RestPatchHTML
RestPatchImage
RestPatchJSON
RestPatchScript
RestPatchText
RestPatchXML
RestPostBinary
RestPostCSS
RestPostCustom
RestPostHTML
RestPostImage
RestPostJSON
RestPostScript
RestPostText
RestPostXML
RestPutBinary
RestPutCSS
RestPutCustom
RestPutHTML
RestPutImage
RestPutJSON
RestPutScript
RestPutText
RestPutXML
RestRequest
TID
Perform an HTTP method on a REST service.
RestStartServiceSession
TID
Start a session for a REST service.

ToolBarFunctions [How To Read This Reference]
ClickButton
RC TC
Deprecated. Use ClickButtonText instead.
ClickButtonIndex
RJ TC
Click on the icon at a certain position on the ToolBar object, it is 1-based.
ClickButtonText
RC RJ TC
Routine to Click on the specified Button.Key (Text) value.
ClickButtonTooltip
RJ
Click on the icon whose tooltip equals to the provided parameter
ClickUnverifiedButtonID
RC
Routine to select a toolbar button using it's ID.
ClickUnverifiedButtonText
RC RJ TC
Routine to Click on the specified Button.Key (Text) value.
VerifyButtonClicked
RC
Verifies a particular case-sensitive button text item is selected
VerifyButtonCount
RC
Verifies a total button presents in the Toolbar.
VerifyButtonText
RC
Verifies a particular case-sensitive text (button.key) item exists
VerifyButtonUnClicked
RC
Verifies a particular case-sensitive button text item is unselected

TreeViewFunctions [How To Read This Reference]
ActivateUnverifiedTextNode
RC RJ
Action to (almost) blindly activate (double-click) a text node.
CaptureTreeDataToFile
RC RJ TC SE2
Copy the current contents of a tree[branch] to a file.
CheckTextNode
RC
Checks a node's state icon (checkbox) according to its associated text value.
ClickPartial
RC RJ TC SE2
Action to click a node according to a partial match of its text value.
ClickTextNode
RC RJ TC SE2
Action to click a node according to its text value.
ClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly click a text node.
Collapse
RC RJ TC SE2
Action to collapse a node according to its text value.
CollapsePartial
RC RJ TC SE2
Action to collapse a node according to a partial match of its text value.
CollapsePartialTextNode
RC RJ
Action to collapse a node according to a partial match of its text value.
CollapseTextNode
RC RJ WR TC
Action to collapse a node according to its text value. Use Collapse instead.
CollapseUnverifiedTextNode
RC RJ SE2
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
RJ SE2
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.
DoubleClickPartial
RC RJ TC SE2
Action to double click a node according to a partial match of its text value.
DoubleClickTextNode
RC RJ TC SE2
Action to double click a node according to its text value.
DoubleClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly activate (double-click) a text node.
Expand
RC RJ TC SE2
Action to expand a node according to its text value.
ExpandPartial
RC RJ TC SE2
Action to expand a node according to a partial match of text value.
ExpandPartialTextNode
RC RJ
Action to expand a node according to a partial match of text value.
ExpandTextNode
RC RJ WR TC
Action to expand a node according to its text value. Use Expand instead.
ExpandUnverifiedTextNode
RC RJ SE2
Action to blindly expand a node according to its text value.
PartialMatchTreeDataToFile
RC RJ
Copy the current contents of a tree[branch] to a file according to a partial match of itss text value.
RightClickPartial
RC RJ TC SE2
Action to right click a node according to a partial match of its text value.
RightClickTextNode
RC RJ TC SE2
Action to right click a node according to its text value.
RightClickUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly right-click a text node.
Select
RC RJ TC SE2
Action to select a node according to its text value.
SelectAnotherPartialTextNode
RC 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
RC RJ
Action to select a node according to its text value, in addition to any nodes already selected.
SelectAnotherUnverifiedTextNode
RC RJ
Action to blindly select a node according to its text value, in addition to any nodes already selected.
SelectPartial
RC RJ TC SE2
Action to select a node according to a partial match of its text value.
SelectPartialTextNode
RC RJ TC
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.
SelectPartialTextNodeSpecial
TC
Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click. The Selection is made according to a partial match of its text value.
SelectStateIcon
RC
Select/check a node's state icon (checkbox) according to its associated text value.
SelectTextNode
RC RJ WR TC
Action to select a node according to its text value.
SelectTextNodeSpecial
TC
Holds down either Ctrl or Shift while making an item selection with emulating either a Left or Right mouse click.
SelectUnverifiedTextNode
RC RJ TC SE2
Action to (almost) blindly click a text node.
SelectUnverifiedTextNodeRightClick
RC TC
Skips many pre- and post-verification checks for right-clicks. Deprecated. Use RightClick instead.
SetTreeContainsNode
RC RJ TC SE2
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
RC RJ SE2
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 SE2
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
UnCheckTextNode
RC
UnChecks a node's state icon (checkbox) according to its associated text value.
VerifyNodeUnselected
RC RJ WR TC SE2
Action to verify a particular text node is NOT selected.
VerifySelectedNode
RC RJ WR TC SE2
Action to verify a particular text node is selected.
VerifyStateIcon
RC
Action to verify a particular state icon is selected/Checked.
VerifyStateIconUnselected
RC
Action to verify a particular state icon is NOT selected.
VerifyTextNodeChecked
RC
Action to verify a particular state icon is selected.
VerifyTextNodeUnChecked
RC
Action to verify a particular state icon is NOT checked.
VerifyTreeContainsNode
RC RJ TC SE2
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
RC RJ TC SE2
Verify that a tree contains the provided node according to a partial match of the node's text value.

VSFlexGridFunctions [How To Read This Reference]
ClickCell
RC
Attempts to perform a single Click on a table cell.
SelectCell
RC
Attempts to perform a Select on a table cell.
VerifyValuesToFile
RC
Verify the string values of a grid block to a file benchmark.

WindowFunctions [How To Read This Reference]
Click
WR
Performs a click on any part of a Window based on a stored x,y coordinate.
CloseWindow
RC RJ WR SE SE2 TC AUT
Sends a Close command to the active window.
CompareStoredProperties
WR
Performs a WindowVP CompareProperties on an object.
DoubleClick
WR
Performs a double-click on any part of a Window based on a stored x,y coordinate.
GetWinInfo
WR
Gets the value of any property in a window.
GoBack
DRD
Make the application\device "go back" to the previous state or window.
InputCharacters
WR
Sends literal text to the active window via an InputChars command.
InputKeys
WR
Sends keystrokes to the active window via an InputKeys command.
Maximize
RC RJ WR SE TC SE2 AUT
Sends a WMaximize command to the active window.
Minimize
RC RJ WR SE TC SE2 AUT
Sends a WMinimize command to the active window.
PinchClose
IOS
Perform a shrinking "zoom out" operation on a touchscreen device supporting the feature.
PinchOpen
IOS
Perform an expanding "zoom in" operation on a touchscreen device supporting the feature.
Restore
RC RJ WR SE TC SE2 AUT
Sends a RestorePos command to the active window.
RightClick
WR
Performs a right-click on any part of a Window based on a stored x,y coordinate.
SelectMenuID
RC WR
Attempts to select a particular menuitem by menuID.
SelectMenuItem
RC RJ WR
Attempts to select a particular text string menuitem.
SelectMenuItemContains
RC RJ WR
Attempts to select a menuitem based on a partial text match.
SetFocus
SE
Set focus on the window.
SetPosition
RC RJ WR SE TC SE2 AUT
Sends a SetPosition command to the window to set the position, size, and status of the window.
VerifyImage
RC WR
Performs a WindowVP CompareImage OR a RegionImageVP on an object.
VerifyMainMenu
RC WR
Compares the active windows menu system with a benchmark
VerifyMenuID
RC WR
Attempts to verify the state information of a particular menuitem identified by MenuID.
VerifyMenuItem
RC RJ WR
Attempts to verify the state information of a particular text string menuitem.
VerifyMenuItemContains
RC RJ WR
Attempts to verify the state information of a menuitem found by partial text match.
VerifyOCRValue
RC WR
Performs an UNLOGGED WindowVP CompareImage OR a RegionImageVP on an object then attempts to retrieve and compare OCR text to the expected value provided.


ENGINE COMMANDS

EngineComponentCommands [How To Read This Reference]
ClearHighlightedDialog
RJ DRD
Clean the highlight rectangle.
ClearReferenceCache
TC DRD
Clear the Object reference cache used in a remote engine.
EnableDomains
RJ
Enable searching domains.
GetAccessibleName
DRD RJ
Get the AccessibleName of the component, if any.
GetCaption
RJ DRD
Get the Caption of a component, if any.
GetChildCount
RJ DRD
Get the number of children, if any, for the provided container component.
GetChildren
RJ DRD
Get references to the children, if any, for the provided container component.
GetClassIndex
DRD
Get the ClassIndex of the component, if any.
GetClassname
DRD RJ
Get the Classname of a component.
GetComponentRectangle
RJ
Find the component according to Component Test Object's key and get its screen location.
GetCurrentWindow
DRD TC
Return a reference to the top-most active (Window) with focus.
GetId
RJ DRD
Get the ID of a component, if any.
GetLevel
RJ
Get the Z-order of a component--usually a Window.
GetMatchingChildKeysAtPoint
RJ DRD
According to screen location, find the test object at that point and return all matching keys in cache.
GetMatchingChildObjects
RJ DRD
Retrieve an array of child objects that match a recognition string.
GetMatchingParentObject
DRD 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
DRD RJ
Get the Name (AccessibleName or Name) of the component, if any. The AccessibleName shall be found first and returned, if any.
GetNonAccessibleName
DRD RJ
Get the non-AccessibleName (Name except for AccessibleName) of the component, if any.
GetProperty
DRD RJ
Get the value of a specific property from a component.
GetPropertyNames
DRD RJ
Get the names of all available properties for a component.
GetStringData
Get the values, text, or data associated with the component.
GetSuperClassnames
DRD RJ
Get the hierarchy of superclasses for the component.
GetText
DRD RJ
Get the (text) value of a component, if any.
GetTopLevelCount
DRD RJ TC
Get the number of visible top-level items (Windows?) for the engine.
GetTopLevelWindows
DRD TC 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 DRD
Find the component according to Window/Component Test Object's key and highlight it.
IsEnabled
TC DRD
Is the component Enabled (vs. disabled)?
IsMatchingPath
RJ
Determine if there is a matching Path object.
IsShowing
TC DRD RJ
Is the component visible?
IsTopLevelPopupContainer
TC DRD
Is the component a top-level Popup Container?
IsValid
TC DRD RJ
Does the component still exist as a valid object?
SetActiveWindow
TC DRD RJ
Make the component the active (topmost?) Window or Component.


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