Selenium ListBoxFunctions

Last Updated:

Actions for working with ListBox objects


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

Selenium ListBoxFunctions::ActivatePartialMatch
SE

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
  1. TextValue
    Case-sensitive substring of node to DblClick and verify.

    TextValue should contain the case-sensitive substring to DblClick and verify.

Examples:
  • T, WINDOW, ListBox, ActivatePartialMatch , "ATextSubstring"
    DblClicks the first item containing the substring in the ListBox. The selection is then verified as having occurred.


[How To Read This Reference]

Selenium ListBoxFunctions::ActivateTextItem
SE

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
  1. TextValue
    Case-sensitive text of node to DblClick and verify.

    TextValue should contain the case-sensitive text item to DblClick and verify.

Examples:
  • T, WINDOW, ListBox, ActivateTextItem , "AParticularUserID"
    DblClicks "AParticularUserID" in the ListBox object.

    Dblclicks "AParticularUserID" in the ListBox object. The current value of the selection is then verified.

[How To Read This Reference]

Selenium ListBoxFunctions::ActivateUnverifiedPartialMatch
SE

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
  1. TextValue
    Case-sensitive substring of node to DblClick.

    TextValue should contain the case-sensitive substring to DblClick.

Examples:
  • T, WINDOW, ListBox, ActivateUnverifiedPartialMatch , "ATextSubstring"
    DblClicks the first item containing the substring in the ListBox.

    DblClicks the first item containing the substring in the ListBox.

    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.



[How To Read This Reference]

Selenium ListBoxFunctions::ActivateUnverifiedTextItem
SE

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
  1. 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:
  • T, WINDOW, ListBox, ActivateUnverifiedTextItem , "AParticularUserID"
    DblClicks "AParticularUserID" in the ListBox object.

    Dblclicks "AParticularUserID" in the ListBox object.

    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.



[How To Read This Reference]

Selenium ListBoxFunctions::SelectAnotherTextItem
SE

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
  1. 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]

Selenium ListBoxFunctions::SelectAnotherUnverifiedTextItem
SE

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...)

Fields: [ ]=Optional with Default Value
  1. TextValue
    Case-sensitive text of node to select.


Examples:
  • T, WINDOW, ListBox, SelectAnotherUnverifiedTextItem , "AParticularUserID"
    Selects "AParticularUserID" from the ListBox object.

    Selects "AParticularUserID" from the ListBox. The item is selected and added to the rest of the items already selected.

[How To Read This Reference]

Selenium ListBoxFunctions::SelectIndex
SE

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
  1. Index
    Index of the text item to select, starting from 1

    Index of the text item to select, starting from 1

Examples:
  • T, WINDOW, ListBox, SelectIndex , 1
    Selects the first item in the list.

    Selects the first item in the list.

[How To Read This Reference]

Selenium ListBoxFunctions::SelectPartialMatch
SE

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
  1. TextValue
    Case-sensitive substring of node to select and verify.

    TextValue should contain the case-sensitive substring to select and verify.

Examples:
  • T, WINDOW, ListBox, SelectPartialMatch , "ATextSubstring"
    Clicks the first item containing the substring text in the ListBox.

    Clicks the first item containing the substring text in the ListBox. After the selection we verify the item is selected.

[How To Read This Reference]

Selenium ListBoxFunctions::SelectTextItem
SE

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
  1. TextValue
    Case-sensitive text of node to select and verify.

    TextValue should contain the case-sensitive text item to select and verify.

Examples:
  • T, WINDOW, ListBox, SelectTextItem , "AParticularUserID"
    Selects "AParticularUserID" from the ListBox object.

    Selects "AParticularUserID" from the ListBox object and verifies the selection actually occurred.

[How To Read This Reference]

Selenium ListBoxFunctions::SelectUnverifiedPartialMatch
SE

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
  1. TextValue
    Case-sensitive substring of node to select.

    TextValue should contain the case-sensitive substring to select.

Examples:
  • T, WINDOW, ListBox, SelectUnverifiedPartialMatch , "ATextSubstring"
    Clicks the first item containing the substring text in the ListBox.

    Clicks the first item containing the substring text in the ListBox.

    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.



[How To Read This Reference]

Selenium ListBoxFunctions::SelectUnverifiedTextItem
SE

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
  1. 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:
  • T, WINDOW, ListBox, SelectUnverifiedTextItem , "AParticularUserID"
    Selects "AParticularUserID" from the ListBox object.

    Selects "AParticularUserID" from the ListBox object.

    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.



[How To Read This Reference]

Selenium ListBoxFunctions::VerifyItemUnselected
SE

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
  1. 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:
  • T, WINDOW, ListBox, VerifyItemUnselected, "AParticularUserID"
    Verifies that "AParticularUserID" is NOT selected in the ListBox.


[How To Read This Reference]

Selenium ListBoxFunctions::VerifyListContains
SE

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
  1. TextValue
    String to look for in the list.

    String to look for in the list.

  2. [ 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]

Selenium ListBoxFunctions::VerifyListContainsPartialMatch
SE

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
  1. TextValue
    SubString to look for in the list.

    SubString to look for in the list.

  2. [ 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]

Selenium ListBoxFunctions::VerifyListDoesNotContain
SE

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
  1. TextValue
    String to look for in the list.

    String to look for in the list.

  2. [ 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]

Selenium ListBoxFunctions::VerifyListDoesNotContainPartialMatch
SE

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
  1. TextValue
    SubString to look for in the list.

    SubString to look for in the list.

  2. [ 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]

Selenium ListBoxFunctions::VerifySelectedItem
SE

Verifies a particular case-sensitive text item is selected

Verifies a particular case-sensitive text item is selected

Fields: [ ]=Optional with Default Value
  1. 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:
  • T, WINDOW, ListBox, VerifySelectedItem , "AParticularUserID"
    Verifies that "AParticularUserID" is selected in the ListBox.


[How To Read This Reference]

Selenium ListBoxFunctions::VerifySelectedPartialMatch
SE

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
  1. 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:
  • T, WINDOW, ListBox, VerifySelectedPartialMatch , "ATextSubstring"
    Verifies that the first item containing the substring is selected in the ListBox.


[How To Read This Reference]