ListBoxFunctions::ActivatePartialMatch
Routine to DblClick and Verify an item according to a partial text match.
Routine to DblClick and Verify an item according to a partial text match.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive substring of node to DblClick and verify.
TextValue should contain the case-sensitive substring to DblClick and verify.
Examples:
[How To Read This Reference]
ListBoxFunctions::ActivateTextItem
Routine to DblClick and Verify an item according to its text value.
Routine to DblClick and Verify an item according to its text value.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to DblClick and verify.
TextValue should contain the case-sensitive text item to DblClick and verify.
Examples:
[How To Read This Reference]
ListBoxFunctions::ActivateUnverifiedPartialMatch
DblClicks an item according to a partial text match.
DblClicks an item according to a partial text match.
The item is activated but no check is performed after
the selection to verify the selection was successful.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive substring of node to DblClick.
TextValue should contain the case-sensitive substring to DblClick.
Examples:
[How To Read This Reference]
ListBoxFunctions::ActivateUnverifiedTextItem
Routine to DblClick an item according to its text value.
Routine to DblClick an item according to its text value.
No check is performed after the selection to verify success.
This is typically done for cases when the listbox is only temporary
in nature and disappears immediately upon a selection.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to DblClick.
TextValue should contain the case-sensitive text item to DblClick.
No check is performed after the selection to verify success.
This is typically done for cases when the listbox is only temporary
in nature and disappears immediately upon a selection.
Examples:
[How To Read This Reference]
ListBoxFunctions::CaptureItemsToFile
Capture Items To a File specified (if not abs, then to test dir)
Capture Items To a File specified (if not abs, then to test dir)
Fields: [ ]=
Optional with Default Value
-
FileName
File name (if not absolute, then to test dir)
File name (if not absolute, then to test dir)
- [ FileEncoding = ]
Specify a character encoding to be used when saving data to a file.
If it is not specified, the system default file encoding will be used.
The encoding should be a valid string supported by Java; if it is not valid,
the system default file encoding will be used instead.
Examples:
-
T, WINDOW, ListBox, CaptureItemsToFile , afile.txt
Captures all the items in the list to ...\datapool\test\afile.txt
Captures all the items in the list to ...\datapool\test\afile.txt
-
T, WINDOW, ListBox, CaptureItemsToFile , afile.txt, "UTF-8"
Captures all the items in the list to ...\datapool\test\afile.txt
Captures all the items in the list to ...\datapool\test\afile.txt
Writing file with "UTF-8" encoding.
[How To Read This Reference]
ListBoxFunctions::ClickColumnIndex
Click a column header based on it's index of list, starting from 1
Click a column header based on it's index of list, starting from 1
Fields: [ ]=
Optional with Default Value
-
Index
Index of the column header to click, starting from 1
Index of the column header to click, starting from 1
Examples:
[How To Read This Reference]
ListBoxFunctions::ClickColumnLabel
Click a column header based on it's label
Click a column header based on it's label
Fields: [ ]=
Optional with Default Value
-
Label
Label of the column header to click
Label of the column header to click
Examples:
[How To Read This Reference]
ListBoxFunctions::ClickTextItem
Routine to Click a selection according to its text value.
Note: This keyword triggers the click event
Routine to Click a selection according to its text value.
NOTE: Only ClickTextItem keyword triggers the click event. SelectTextItem
keyword fails to trigger click event on some instances.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to select.
TextValue should contain the case-sensitive text item to select.
Examples:
[How To Read This Reference]
ListBoxFunctions::ExtendSelectionToTextItem
Routine to Shift+Click and Verify a selection according to its text value.
This extends the current selection to include the specified
selection and all other items inbetween.
NOTE: This may not work in all environments (Java, Web, etc...)
For example, in Java, we can usually verify that an item exists
in the list; but we do not seem to be able to verify if a newly
added selection to multiple selections is actually selected.
So, for Java, we will verify existence in the list, but we cannot
verify the selection was successful--we will skip that last check.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to select and verify.
Examples:
-
T, WINDOW, ListBox, ExtendSelectionToTextItem, "AParticularUserID"
Selects "AParticularUserID" from the ListBox object.
Selects "AParticularUserID" from the ListBox object.
This adds "AParticularUserID" and any items inbetween to
any existing items already selected.
When possible, we will also attempt to verify the added selection
was successful.
[How To Read This Reference]
ListBoxFunctions::RightClickTextItem
Routine to Right-Click a selection according to its text value.
Note: This keyword triggers the right-click event.
Routine to Right-Click a selection according to its text value.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to right-click on.
TextValue should contain the case-sensitive text item to right-click.
Examples:
[How To Read This Reference]
ListBoxFunctions::SelectAnotherTextItem
Routine to Control+Click and Verify a selection according to its text value.
This adds selected items to items already selected.
NOTE: This may not work in all environments (Java, Web, etc...)
For example, in Java, we can usually verify that an item exists
in the list; but we do not seem to be able to verify if a newly
added selection to multiple selections is actually selected.
So, for Java, we will verify existence in the list, but we cannot
verify the selection was successful--we will skip that last check.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to select and verify.
Examples:
-
T, WINDOW, ListBox, SelectAnotherTextItem , "AParticularUserID"
Selects "AParticularUserID" from the ListBox object.
Selects "AParticularUserID" from the ListBox object.
This adds to any existing items already selected.
When possible, we will also attempt to verify the added selection
was successful.
[How To Read This Reference]
ListBoxFunctions::SelectAnotherUnverifiedTextItem
Routine to Control+Click an item according to its text value.
No post-select verification of the selection is performed.
Routine to Control+Click an item according to its text value.
No post-select verification of the selection is performed. This selection
is added to any items already selected.
NOTE: This may not work in all environments (Java, Web, etc...)
ListBoxFunctions::SelectIndex
Select an item based on it's index in the list, starting from 1
Select an item based on it's index in the list, starting from 1
Fields: [ ]=
Optional with Default Value
-
Index
Index of the text item to select, starting from 1
Index of the text item to select, starting from 1
Examples:
[How To Read This Reference]
ListBoxFunctions::SelectPartialMatch
Routine to Click and Verify an item according to a partial text match.
Routine to Click and Verify an item according to a partial text match.
Note: for RobotJ, same as SelectUnverifiedPartialMatch
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive substring of node to select and verify.
TextValue should contain the case-sensitive substring to select and verify.
Examples:
[How To Read This Reference]
ListBoxFunctions::SelectTextItem
Routine to Click and Verify a selection according to its text value.
Routine to Click and Verify a selection according to
its text value.
Note: RobotJ also uses the identical keyword 'Select'
Note: For RobotJ, there is no additional verify step in
the framework code, in other words, for
RobotJ, the SelectTextItem and
SelectUnverifiedTextItem keywords are identical
because RobotJ does all of the verification internally
and there is no control over that in it's api.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to select and verify.
TextValue should contain the case-sensitive text item to select and verify.
Examples:
[How To Read This Reference]
ListBoxFunctions::SelectUnverifiedAnotherTextItem (deprecated for: SelectAnotherUnverifiedTextItem)
Use the identical "SelectAnotherUnverifiedTextItem" instead.
Routine to Control+Click an item according to its text value.
No post-select verification of the selection is performed. This selection
is added to any items already selected.
NOTE: This may not work in all environments (Java, Web, etc...)
ListBoxFunctions::SelectUnverifiedPartialMatch
Routine to Click an item according to a partial text match.
Routine to Click an item according to a partial text match.
No check is performed after the selection to verify success.
This is typically done for cases when the listbox is only temporary
in nature and disappears immediately upon a selection.
Note: for RobotJ, same as SelectPartialMatch
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive substring of node to select.
TextValue should contain the case-sensitive substring to select.
Examples:
[How To Read This Reference]
ListBoxFunctions::SelectUnverifiedTextItem
Routine to Click a selection according to its text value.
Routine to Click a selection according to its text value.
No check is performed after the selection to verify success.
This is typically done for cases when the listbox is only temporary
in nature and disappears immediately upon a
selection.
Note: RobotJ also uses the identical keyword 'SelectUnverified'
Note: This is the default for RobotJ, in other words, for
RobotJ, the SelectTextItem and
SelectUnverifiedTextItem keywords are identical
because RobotJ does all of the verification internally
and there is no control over that in it's api.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node to select.
TextValue should contain the case-sensitive text item to select.
No check is performed after the selection to verify success.
This is typically done for cases when the listbox is only temporary
in nature and disappears immediately upon a selection.
Examples:
[How To Read This Reference]
ListBoxFunctions::SetListContains
Set a variable with the result of checking that a listview contains the provided item.
The search of the item is expected to be a case-sensitive exact match of the item. The
provided variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.
Fields: [ ]=
Optional with Default Value
-
ItemText
The case-sensitive name of the sought item.
ItemText should contain the case-sensitive text item to find in the list view.
A message is sent to the log confirming whether or not the item is found in the list view.
-
ResultVar
The name of the variable receiving the result.
This variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.
Examples:
-
T, WINDOW, ListView, SetListContains , "AParticularServerName", isFound
Variable isFound is set to 'TRUE' if the item "AParticularServerName" is found
in the ListView object. If the item is not found, the variable isFound is set
to 'FALSE'.
[How To Read This Reference]
ListBoxFunctions::VerifyItem
Verifies a particular case-sensitive item based on index is equal
to a particular value.
Verifies a particular case-sensitive item based on index is equal
to a particular value.
Fields: [ ]=
Optional with Default Value
-
Index
Index of the item in the list starting from 1
Index of the item in the list starting from 1
-
TextValue
Case-sensitive string to compare to the text of the node at the index.
Case-sensitive string to compare to the text of the node at the index.
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifyItemUnselected
Verifies a particular case-sensitive text item is NOT selected.
Verifies a particular case-sensitive text item is NOT selected.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node that will be verified as unselected
TextValue should contain the case-sensitive text of the item that is expected to NOT be selected.
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifyListContains
Verifies a particular list-item exists in the list (somewhere)
Verifies a particular list-item exists in the list (somewhere). The comparison
can be case-sensitive. By default, it is not.
Fields: [ ]=
Optional with Default Value
-
TextValue
String to look for in the list.
String to look for in the list.
- [ CaseSensitive = ]
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search.
Robot (others?) also supports "CASE-SENSITIVE" in place of "TRUE" for this parameter.
Examples:
-
T, WINDOW, ListBox, VerifyListContains, "ATextString", "True"
Verifies that the listbox contains somewhere an item equal to "ATextString"
using a case-sensitive comparison.
-
T, WINDOW, ListBox, VerifyListContains, "ATextString", "Case-Sensitive"
Verifies that the listbox contains somewhere an item equal to "ATextString" using a
case-sensitive comparison. The use of "CASE-SENSITIVE" literal text instead of
"TRUE" initially is implemented on Robot. Other engines will support this as
developers can get in there and add it.
-
T, WINDOW, ListBox, VerifyListContains, "ATextString10", "False"
Verifies that the listbox contains somewhere an item equal to "ATextString10"
case-insensitive search. The "False" is not really necessary since the search
is not case-sensitive by default.
-
T, WINDOW, ListBox, VerifyListContains, "ATextString10"
Verifies that the listbox contains somewhere an item equal to "ATextString10"
using a comparison that is not case-sensitive.
[How To Read This Reference]
ListBoxFunctions::VerifyListContainsPartialMatch
Verifies a particular list-item substring exists in the list (somewhere)
Verifies a particular list-item substring exists in the list (somewhere). The comparison
can be case-sensitive. By default, it is not.
Fields: [ ]=
Optional with Default Value
-
TextValue
SubString to look for in the list.
SubString to look for in the list.
- [ CaseSensitive = ]
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search.
Robot (others?) also supports "CASE-SENSITIVE" in place of "TRUE" for this parameter.
Examples:
-
T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "True"
Verifies that the listbox contains somewhere an item containing the substring "Text"
using a case-sensitive comparison.
-
T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "Case-Sensitive"
Verifies that the listbox contains somewhere an item containing the substring "Text"
using a case-sensitive comparison. The use of "CASE-SENSITIVE" literal text instead of
"TRUE" initially is implemented in Robot. Other engines will support this as
developers can add it.
-
T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "False"
Verifies that the listbox contains somewhere an item containing the substring "Text"
case-insensitive search. The "False" is not really necessary since the search
is not case-sensitive by default.
-
T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text"
Verifies that the listbox contains somewhere an item containing the substring
"Text" using a comparison that is not case-sensitive.
[How To Read This Reference]
ListBoxFunctions::VerifyListDoesNotContain
Verifies a particular list-item does NOT exists in the list (somewhere)
Verifies a particular list-item does NOT exists in the list (somewhere).
The comparison can be case-sensitive. It is NOT case-sensitive by default.
Fields: [ ]=
Optional with Default Value
-
TextValue
String to look for in the list.
String to look for in the list.
- [ CaseSensitive = ]
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search. Robot also supports the literal
string "CASE-SENSITIVE" instead of "TRUE".
Examples:
-
T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString", "True"
Verifies that the listbox does NOT contains somewhere an item equal to "ATextString"
case-sensitive search.
-
T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString", "Case-Sensitive"
Verifies that the listbox does NOT contains somewhere an item equal to "ATextString"
case-sensitive search. The "Case-Sensitive" literal text instead of "True"
may only be supported by Robot initially.
-
T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString10", "False"
Verifies that the listbox does NOT contains somewhere an item equal to "ATextString10"
case-insensitive search. "False" is not really necessary as comparisons here
are NOT case-sensitive by default.
-
T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString10"
Verifies that the listbox does NOT contains somewhere an item equal to "ATextString10"
case-insensitive search.
[How To Read This Reference]
ListBoxFunctions::VerifyListDoesNotContainPartialMatch
Verifies a particular list-item substring does NOT exists in the list (somewhere)
Verifies a particular list-item substring does NOT exists in the list (somewhere).
The comparison can be case-sensitive. It is NOT case-sensitive by default.
Fields: [ ]=
Optional with Default Value
-
TextValue
SubString to look for in the list.
SubString to look for in the list.
- [ CaseSensitive = ]
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search. Robot also supports the literal
string "CASE-SENSITIVE" instead of "TRUE".
Examples:
-
T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "Text", "True"
Verifies that the listbox does NOT contain an item containg the substring "Text"
using a case-sensitive search.
-
T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "String", "Case-Sensitive"
Verifies that the listbox does NOT contain an item containing the substring "String"
using a case-sensitive search. The "Case-Sensitive" literal text instead of "True"
may only be supported by Robot initially.
-
T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "String", "False"
Verifies that the listbox does NOT contain an item containing the substring "String"
using a case-insensitive search. "False" is not really necessary as comparisons here
are NOT case-sensitive by default.
-
T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "Text"
Verifies that the listbox does NOT containan item containing the substring
"Text" using a case-insensitive search.
[How To Read This Reference]
ListBoxFunctions::VerifyMenuItem
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
Verifies a particular case-sensitive menu-item exists
in the list (somewhere)
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive string to compare to the text of any node in the list.
Case-sensitive string to compare to the text of any node in the list.
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifyMenuPartialMatch
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
Verifies a particular case-insensitive menu-item
substring exists in the list (somewhere)
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-insensitive substring to compare to the text of any node in the list.
Case-insensitive substring to compare to the text of any node in the list.
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifyPartialMatch
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
Verifies a particular case-insensitive item based on
index is has as substring a particular value.
Fields: [ ]=
Optional with Default Value
-
Index
Index of the item in the list starting from 1
Index of the item in the list starting from 1
-
TextValue
Case-insensitive substring to compare to the text of the node at the index.
Case-insensitive substring to compare to the text of the node at the index.
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifySelectedItem
Verifies a particular case-sensitive text item is selected
Verifies a particular case-sensitive text item is selected
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive text of node that will be verified as selected
TextValue should contain the case-sensitive text of the item expected to already be selected
Examples:
[How To Read This Reference]
ListBoxFunctions::VerifySelectedPartialMatch
Verifies a particular case-sensitive item is selected
based on a substring match.
Verifies a particular case-sensitive item is selected
based on a substring match.
Fields: [ ]=
Optional with Default Value
-
TextValue
Case-sensitive substring of node that will be verified selected
TextValue should contain the case-sensitive substring of the item expected to already be selected
Examples:
[How To Read This Reference]