Share this page

com.hp.lft.sdk.winforms

## Interface ListBase<T>

- Type Parameters:
    `T` - the item type
  All Known Subinterfaces:
    ListBox, ListView

      public interface ListBase<T>

  Base interface for some .NET Windows Forms list objects.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `void` | `activateItem(int itemIndex)` Activates (double-clicks) the specified item in the list by item index.
    `void` | `activateItem(int itemIndex, MouseButton button)` Activates (double-clicks) the specified item in this list by item index.
    `void` | `activateItem(java.lang.String item)` Activates (double-clicks) the specified item in this list.
    `void` | `activateItem(java.lang.String item, MouseButton button)` Activates (double-clicks) the specified item in this list.
    `void` | `activateItem(T item)` Activates (double-clicks) the specified item in this list.
    `void` | `activateItem(T item, MouseButton button)` Activates (double-clicks) the specified item in this list.
    `void` | `deselect(int... itemIndices)` Deselect a list of items by items indices.
    `void` | `deselect(java.lang.String... items)` Deselect a list of items.
    `void` | `deselect(T... items)` Deselect a list of items.
    `void` | `extendSelect(int... itemIndices)` Selects additional items from the multi-selection list, by index.
    `void` | `extendSelect(java.lang.String... items)` Selects additional items from the multi-selection list, by name.
    `void` | `extendSelect(T... items)` Selects additional items from the multi-selection list, by items.
    `java.lang.String` | `getErrorText()` Returns the tooltip text of the error icon associated with this object.
    `T` | `getItem(java.lang.String text)` Returns the item with the given text.
    `java.util.List<T>` | `getItems()` Returns the items in the list.
    `java.util.List<T>` | `getSelectedItems()` Returns the selected items in the list.
    `void` | `select(int... itemIndices)` Selects a list of items by items indices.
    `void` | `select(java.lang.String... items)` Selects a list of items.
    `void` | `select(T... items)` Selects a list of items.
    `void` | `selectRange(int itemIndexLast)` Selects all list items between the currently selected item and the specified item.
    `void` | `selectRange(int indexFrom, int indexTo)` Selects all list items between (and including) the two specified items.
    `void` | `selectRange(string itemNameLast)` Selects all list items between the currently selected item and the specified item.
    `void` | `selectRange(java.lang.String itemFrom, java.lang.String itemTo)` Selects all list items between (and including) the two specified items.
    `void` | `selectRange(T itemLast)` Selects all list items between the currently selected item and the specified item.
    `void` | `selectRange(T itemFrom, T itemTo)` Selects all list items between (and including) the two specified items.

- - ### Method Detail

    - #### activateItem

          void activateItem(T item,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in this list.
      Parameters:
        `item` - the item to activate
        `button` - the mouse button used to select the list item
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateItem

          void activateItem(java.lang.String item,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in this list.
      Parameters:
        `item` - the item
        `button` - the mouse button used to select the list item
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateItem

          void activateItem(int itemIndex,
                            MouseButton button)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in this list by item index.
      Parameters:
        `itemIndex` - the index
        `button` - the mouse button used to select the list item
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateItem

          void activateItem(T item)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in this list.
      Parameters:
        `item` - the item to activate
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateItem

          void activateItem(java.lang.String item)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in this list.
      Parameters:
        `item` - the item to activate
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### activateItem

          void activateItem(int itemIndex)
                     throws GeneralLeanFtException

      Activates (double-clicks) the specified item in the list by item index.
      Parameters:
        `itemIndex` - the index of the item to activate
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(T... items)
               throws GeneralLeanFtException

      Selects a list of items.
      Parameters:
        `items` - the items to select
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(java.lang.String... items)
               throws GeneralLeanFtException

      Selects a list of items.
      Parameters:
        `items` - the names of the items to select
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### select

          void select(int... itemIndices)
               throws GeneralLeanFtException

      Selects a list of items by items indices.
      Parameters:
        `itemIndices` - the indices of the items to select
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselect

          void deselect(T... items)
                 throws GeneralLeanFtException

      Deselect a list of items.
      Parameters:
        `items` - the items to deselect
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselect

          void deselect(java.lang.String... items)
                 throws GeneralLeanFtException

      Deselect a list of items.
      Parameters:
        `items` - the items to deselect
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### deselect

          void deselect(int... itemIndices)
                 throws GeneralLeanFtException

      Deselect a list of items by items indices.
      Parameters:
        `itemIndices` - the indices of the items to deselect
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### extendSelect

          void extendSelect(int... itemIndices)
          		throws GeneralLeanFtException

      Selects additional items from the multi-selection list, by index.
      Parameters:
        `items` - the indices of the items to add to the selection.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### extendSelect

          void extendSelect(java.lang.String... items)
          		throws GeneralLeanFtException

      Selects additional items from the multi-selection list, by name.
      Parameters:
        `items` - the names of the items to add to the selection.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### extendSelect

          void extendSelect(T... items)
          		throws GeneralLeanFtException

      Selects additional items from the multi-selection list, by items.
      Parameters:
        `items` - the items to add to the selection.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(int itemIndexLast)
                    throws GeneralLeanFtException

      Selects all list items between the currently selected item and the specified item.
      Parameters:
        `itemIndexLast` - the index of the last item to select.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(String itemNameLast)
          	  throws GeneralLeanFtException

      Selects all list items between the currently selected item and the specified item.

      Parameters:
        `itemNameLast` - the name of the last item to select.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(int indexFrom, int indexTo)
          	throws GeneralLeanFtException

      Selects all list items between (and including) the two specified items.
      Parameters:
        `indexFrom` - the 0-based index of the first item in the range.
        `indexTo` - the 0-based index of the last item of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(T itemLast)
          	throws GeneralLeanFtException

      Selects all list items between the currently selected item and the specified item.

      Parameters:
        `itemLast` - the last item to select.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(java.lang.String itemFrom,
            		  java.lang.String itemTo)
          	throws GeneralLeanFtException

      Selects all list items between (and including) the two specified items.
      Parameters:
        `itemFrom` - the name of the first item in the range.
        `itemTo` - the name of the last item of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### selectRange

          void selectRange(T itemFrom, T itemTo)
          		throws GeneralLeanFtException

      Selects all list items between (and including) the two specified items.

      Parameters:
        `itemFrom` - the first item in the range.
        `itemTo` - the last item in the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getItem

                                                      T getItem(java.lang.String text)
             throws GeneralLeanFtException

      Returns the item with the given text.
      Parameters:
        `text` - the text
      Returns:
        the item with the given text.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getItems

          java.util.List<T> getItems()
                              throws GeneralLeanFtException

      Returns the items in the list.
      Returns:
        the items in the list
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getSelectedItems

          java.util.List<T> getSelectedItems()
                                      throws GeneralLeanFtException

      Returns the selected items in the list.
      Returns:
        the selected items
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getErrorText

          java.lang.String getErrorText()
                                 throws GeneralLeanFtException

      Returns the tooltip text of the error icon associated with this object.
      Returns:
        the tooltip text of the error icon associated with this object.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: