ListViewFunctions

Last Updated:10/20/2016 04:38:58

Actions for working with ListView objects


[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

ListViewFunctions::ActivateIndex
DRD SE2

Activate (double-click) an item based on it's index in the list

It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Fields: [ ]=Optional with Default Value
  1. Index
    Index of the text item to select

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Examples:
  • T, WINDOW, ListBox, ActivateIndex , 3
    Selects the item in the list at the specified index.


[How To Read This Reference]

ListViewFunctions::ActivateIndexItem
DRD SE2

Routine to double click an item according to its index in the list.

It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Fields: [ ]=Optional with Default Value
  1. IndexValue
    Index of item to activate.

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Examples:
  • T, WINDOW, ListView, ActivateIndexItem , 3
    Double clicks the ListView item at the specified index.


[How To Read This Reference]

ListViewFunctions::ActivatePartialMatch
TC DRD SE2

Routine to double click an item according to a partial text match.


Fields: [ ]=Optional with Default Value
  1. PartialTextValue
    Case-sensitive substring of text item to select

    PartialTextValue should be a case-sensitive substring of text item to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, ActivatePartialMatch, "ATextSubstring"
    Double clicks the first item containing "ATextSubstring" in the ListView.


  • T, WINDOW, ListView, ActivatePartialMatch , "ATextSubstring", "Index=2"
    Double clicks the 2nd item containing "ATextSubstring" in the ListView.


[How To Read This Reference]

ListViewFunctions::ActivateTextItem
RC WR TC DRD SE2

Routine to double click an item according to its text value.


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

    SelectTextValue should contain the case-sensitive text item to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, ActivateTextItem , "AParticularUserID"
    Double clicks "AParticularUserID" from the ListView object


  • T, WINDOW, ListView, ActivateTextItem , "AParticularUserID", "Index=2"
    Double clicks the 2nd item matching "AParticularUserID" from the ListView object


[How To Read This Reference]

ListViewFunctions::ActivateTextItemCoords
RC SE2

Double click a text item at specific Coords.


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

    SelectTextValue should contain the case-sensitive text item to select.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "5,20"
    Double Click "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "5,20" "Index=3"
    Double Click the 3rd item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "Coords=5,20"
    Double Click "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateTextItemCoords "AParticularUserID" CENTER
    Double Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::ActivateUnverifiedTextItem
RC TC DRD SE2

Routine to double click an unverifiable item according to its text value.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to select. The selection will not be verified.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, ActivateUnverifiedTextItem , "AParticularUserID"
    Double click "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

  • T, WINDOW, ListView, ActivateUnverifiedTextItem , "AParticularUserID", "Index=3"
    Double click the 3rd item matching "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

[How To Read This Reference]

ListViewFunctions::ActivateUnverifiedTextItemCoords
RC SE2

Double click an unverifiable text item at specific Coords.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to select.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "5,20"
    Double Click "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=2"
    Double Click the 2nd item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"
    Double Click "AParticularUserID" at specific coords.


  • T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" CENTER
    Double Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::AssignCellValue
RC

Assigns the value of a cell in a listview to a variable.


Fields: [ ]=Optional with Default Value
  1. Varibale
    Name of variable to assign value

    The variable name that should be used to hold the value retrieved by this command.

  2. RowCoord
    The coordinate of the row in the listview that you want to capture the value.

    We will capture the row, column value in the listview and assign it to the variable value. First you identify the row and then the column.

  3. ColCoord
    The coordinate of the column in the listview that you want to capture the value.

    We will capture the row, column value in the listview and assign it to the variable value. First you identify the row and then the column.

Examples:
  • T WINDOW MyList AssignCellValue "^variablename" 2 3
    Assigns the value in the 2nd row, 3rd column of the "MyList" listview to a variable named "variablename."


[How To Read This Reference]

ListViewFunctions::CaptureItemsToFile
DRD TC SE2

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
  1. FileName
    File name (if not absolute, then to test dir)

    File name (if not absolute, then to test dir)

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

ListViewFunctions::ClickIndex
DRD SE2

Same as (Alias for) ListView ActivateIndexItem


Fields: [ ]=Optional with Default Value
  1. Index
    See ListView ActivateIndexItem


Examples:
  • T, WINDOW, ListBox, ClickIndex , 3
    Activates the item in the list at the provided index. (See ListView ActivateIndexItem)


[How To Read This Reference]

ListViewFunctions::ClickIndexItem
DRD SE2

Same as (Alias for) ListView ActivateIndexItem


Fields: [ ]=Optional with Default Value
  1. Index
    See ListView ActivateIndexItem


Examples:
  • T, WINDOW, ListBox, ClickIndexItem , 3
    Activates the item in the list at the provided index. (See ListView ActivateIndexItem)


[How To Read This Reference]

ListViewFunctions::ExtendSelectionToTextItem
TC SE2

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

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


Examples:
  • T, WINDOW, ListView, ExtendSelectionToTextItem, "AParticularUserID"
    Selects "AParticularUserID" from the ListView object with Shfit key pressedd down.

    Selects "AParticularUserID" from the ListView object with Shfit key pressedd down. 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]

ListViewFunctions::RightClickTextItem
RC TC SE2

Routine to RightClick (single click) an item according to its text value.


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

    SelectTextValue should contain the case-sensitive text item to RightClick.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, RightClickTextItem , "AParticularUserID"
    RightClick "AParticularUserID" from the ListView object


  • T, WINDOW, ListView, RightClickTextItem , "AParticularUserID", "Index=2"
    RightClick the 2nd text item matching "AParticularUserID" from the ListView object


[How To Read This Reference]

ListViewFunctions::RightClickTextItemCoords
RC SE2

Right click a text item at specific Coords.


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

    SelectTextValue should contain the case-sensitive text item to RightClick.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "5,20"
    Right Click "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "5,20" "Index=2"
    Right Click the 2nd text item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "Coords=5,20"
    Right Click "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickTextItemCoords "AParticularUserID" CENTER
    Right Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::RightClickUnverifiedTextItem
RC

Routine to RightClick (single click) an unverifiable item according to its text value.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to RightClick. The selection will not be verified.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, RightClickUnverifiedTextItem , "AParticularUserID"
    RightClick "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

  • T, WINDOW, ListView, RightClickUnverifiedTextItem , "AParticularUserID", "Index=3"
    RightClick the 3rd text item matching "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

[How To Read This Reference]

ListViewFunctions::RightClickUnverifiedTextItemCoords
RC

Right Click an unverifiable text item at specific Coords.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to RightClick.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "5,20"
    Right Click "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=3"
    RightClick the 3rd text item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"
    Right Click "AParticularUserID" at specific coords.


  • T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" CENTER
    Right Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::SelectAnotherPartialMatch
TC SE2

Routine for multiple selection to Control+Click on an item according to a partial text match.

This adds selected items to items already selected.


Fields: [ ]=Optional with Default Value
  1. PartialTextValue
    Case-sensitive substring of text item to select.


  2. [ MatchIndex = 1 ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, SelectAnotherPartialMatch, "ASubstring"
    Ctrl+Clicks the first item containing "ASubstring" in the ListView.

    Ctrl+Clicks the first item containing "ASubstring" in the ListView. This adds to any existing items already selected.


  • T, WINDOW, ListView, SelectAnotherPartialMatch, "ASubstring", "Index=2"
    Ctrl+Clicks the 2th item containing "ASubstring" in the ListView.


[How To Read This Reference]

ListViewFunctions::SelectAnotherTextItem
TC SE2

Routine for multiple selection to Control+Click on an item by its text value.

This adds selected items to items already selected.


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


  2. [ MatchIndex = 1 ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, SelectAnotherTextItem , "AParticularUserID"
    Ctrl+Clicks "AParticularUserID" from the ListView object.

    Ctrl+Clicks "AParticularUserID" from the ListView object. This adds to any existing items already selected.


  • T, WINDOW, ListView, SelectAnotherTextItem , "AParticularUserID", "Index=2"
    Ctrl+Clicks the 2th item matching "AParticularUserID" from the ListView object.


[How To Read This Reference]

ListViewFunctions::SelectIndex
DRD SE2

Same as (Alias for) ListView SelectIndexItem


Fields: [ ]=Optional with Default Value
  1. Index
    See ListView SelectIndexItem


Examples:
  • T, WINDOW, ListBox, SelectIndex , 3
    Selects the item in the list at the provided index. (See ListView SelectIndexItem)


[How To Read This Reference]

ListViewFunctions::SelectIndexItem
RC WR TC DRD SE2

Routine to single click an item according to its Index value.

It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Fields: [ ]=Optional with Default Value
  1. ItemIndex
    Index of node to select.


Examples:
  • T, WINDOW, ListView, SelectIndexItem , 4
    Selects the item at Index 4.

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

[How To Read This Reference]

ListViewFunctions::SelectIndexItemCoords
RC SE2

Routine to single click an item by Index at specific coordinates.

It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

Fields: [ ]=Optional with Default Value
  1. ItemIndex
    Index of node to select.


  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120



Examples:
  • T WINDOW MyList SelectIndexItemCoords "2" "5,20"
    Single Click item index "2" at specific coords.

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

  • T WINDOW MyList SelectIndexItemCoords "2" "Coords=5,20"
    Single Click item index "2" at specific coords.

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

  • T WINDOW MyList SelectIndexItemCoords "2" "Center"
    Single Click item index "2" at coords defined in App Map.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

    It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.



[How To Read This Reference]

ListViewFunctions::SelectPartialMatch
TC DRD SE2

Routine to select (single click) an item according to a partial text match.


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

    PartialTextValue should be a case-sensitive substring of text item to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, SelectPartialMatch , "APartialString"
    Selects the first item containing "APartialString" in the ListView.


  • T, WINDOW, ListView, SelectPartialMatch , "APartialString", "Index=2"
    Selects the 2nd text item containing "APartialString" in the ListView.


[How To Read This Reference]

ListViewFunctions::SelectRandomItems
RC WR

Routine to randomly select multiple items in the ListView object.

Routine to randomly select multiple items in the ListView object. Each selection is done with a CTRL + Single Left Click. Items are selected by index, not by their text values. Items already selected are NOT unselected. We add to existing selections.

Fields: [ ]=Optional with Default Value
  1. ItemCount
    The quantity of items to randomly select in the object.


Examples:
  • T, WINDOW, ListView, SelectRandomItems , "3"
    Randomly selects 3 items from the ListView object.


[How To Read This Reference]

ListViewFunctions::SelectTextItem
RC WR TC DRD SE2

Routine to select (single click) an item according to its text value.


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

    SelectTextValue should contain the case-sensitive text item to select.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



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


  • T, WINDOW, ListView, SelectTextItem , "AParticularUserID", "Index=2"
    Selects the 2nd text item matching "AParticularUserID" from the ListView object


[How To Read This Reference]

ListViewFunctions::SelectTextItemCoords
RC SE2

Single click a text item at specific Coords.


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

    SelectTextValue should contain the case-sensitive text item to select.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120

    The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList SelectTextItemCoords "AParticularUserID" "5,20"
    Single Click "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectTextItemCoords "AParticularUserID" "5,20" "Index=2"
    Single Click the 2nd text item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectTextItemCoords "AParticularUserID" "Coords=5,20"
    Single Click "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectTextItemCoords "AParticularUserID" CENTER
    Single Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::SelectUnverifiedTextItem
RC TC DRD SE2

Routine to select (single click) an unverifiable item according to its text value.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to select. The selection will not be verified.

  2. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T, WINDOW, ListView, SelectUnverifiedTextItem , "AParticularUserID"
    Selects "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

  • T, WINDOW, ListView, SelectUnverifiedTextItem , "AParticularUserID", "Index=3"
    Selects the 3rd text item matching "AParticularUserID" from the ListView object.

    The selection will not (cannot) be verified.

[How To Read This Reference]

ListViewFunctions::SelectUnverifiedTextItemCoords
RC SE2

Single click an unverifiable text item at specific Coords.

An unverifiable item is one whose READ value is not the same as its SET value.

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

    SelectTextValue should contain the case-sensitive text item to select.

  2. Coords
    The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.

    We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.

    We expect the coordinates in the format "x,y":

    [MyListView]
    Center=5,120 OR
    Center=Coords=5,120



  3. [ MatchIndex = ]
    Optional index of the Nth duplicate item to match.

    Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.

    The value of the parameter can have 2 forms:

    • A numeric value. Ex: "3"
    • Index prefixed value. Ex: "Index=3"



Examples:
  • T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "5,20"
    Single Click "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=3"
    Single Click the 3rd text item matching "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"
    Single Click "AParticularUserID" at specific coords.


  • T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" CENTER
    Single Click "AParticularUserID" at coords defined in the App Map in a [MyList] section.

    Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.



[How To Read This Reference]

ListViewFunctions::SetListContains
RC TC SE2

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

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

ListViewFunctions::VerifyItemUnselected
RC WR TC SE2

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 unselected

    TextValue should contain the case-sensitive text of the item that is expected NOT to be selected.

Examples:
  • T, WINDOW, ListView, VerifyItemUnselected, "AParticularUserID"
    Verifies that "AParticularUserID" is NOT selected in the ListView.


[How To Read This Reference]

ListViewFunctions::VerifyListContains
RC TC SE2

Verify that a list view contains the provided item.

The search of the item is expected to be a case-sensitive exact match of the item.

Fields: [ ]=Optional with Default Value
  1. ItemText
    The case-sensitive name of the item to verify.

    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.

Examples:
  • T, WINDOW, ListView, VerifyListContains , "AParticularServerName"
    Verify the item "AParticularServerName" is found in the ListView object.


[How To Read This Reference]

ListViewFunctions::VerifySelectedItem
RC WR TC SE2

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 selected

    TextValue should contain the case-sensitive text of the item expected to already be selected

Examples:
  • T, WINDOW, ListView, VerifySelectedItem , "AParticularUserID"
    Verifies that "AParticularUserID" is selected in the ListView.


[How To Read This Reference]