Open topic with navigation

com.hp.lft.sdk.winforms

## Interface ScrollBar

- All Superinterfaces:
    Clickable, DoubleClickable, LocationInfoProvider, SupportDragAndDrop, SupportSendKeys, SupportsNativeObject, TestObject, TestObjectDescriber, UiObjectBase, VisibleProvider, WaitUntilVisibleProvider, WaitUntilEnabledProvider, EnabledProvider

      public interface ScrollBar
      extends UiObjectBase, TestObject

  A .NET Windows Forms scroll bar.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getErrorText()` Returns the tooltip text of the error icon associated with this object.
    `int` | `getPosition()` Returns the scroll bar position.
    `void` | `nextLine()` Moves the scroll bar downward a single lineor emulates pressing the right arrow key once.
    `void` | `nextLine(int numberOfLines)` Moves this scroll bar down the specified number of lines or emulates pressing the right arrow key the specified number of times.
    `void` | `nextPage()` Moves the scroll bar down or to the right a single page.
    `void` | `nextPage(int numberOfPages)` Moves this scroll bar down or to the right the specified number of pages.
    `void` | `previousLine()` Moves the scroll bar up or to the left a single line.
    `void` | `previousLine(int numberOfLines)` Moves this scroll bar up the specified number of lines or emulates pressing the left arrow key the specified number of times.
    `void` | `previousPage()` Moves the scroll bar up or to the left a single page.
    `void` | `previousPage(int numberOfPages)` Moves the scroll bar up or to the left the specified number of pages.
    `void` | `setPosition(int position)` Sets the scroll bar position.

    - ### Methods inherited from interface com.hp.lft.sdk.winforms.UiObjectBase

      `fireEvent, getFullNamePath, getFullType, getObjectName, getObjectProperty, getText, getWindowClassRegExp, getWindowId, isChildWindow, isOwnedWindow`

    - ### Methods inherited from interface com.hp.lft.sdk.UiObjectBase

      `getHandle, getNativeClass, getWindowTitleRegExp, isEnabled, isFocused, isVisible, mouseMove`

    - ### Methods inherited from interface com.hp.lft.sdk.Clickable

      `click, click, click`

    - ### Methods inherited from interface com.hp.lft.sdk.DoubleClickable

      `doubleClick, doubleClick, doubleClick`

    - ### Methods inherited from interface com.hp.lft.sdk.LocationInfoProvider

      `getAbsoluteLocation, getLocation, getSize`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportSendKeys

      `sendKeys, sendKeys`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportDragAndDrop

      `dragAndDropOn, dragAndDropOn`

    - ### Methods inherited from interface com.hp.lft.sdk.SupportsNativeObject

      `getNativeObject`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObject

      `exists, exists, findChildren, getDescription, getDisplayName, getParent, getSnapshot, getTextLocations, getTextLocations, getVisibleText, getVisibleText, highlight, highlightMatches, setDescription, setDisplayName, verifyImageExists, verifyImageExists, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, verifyImageMatch, waitUntilExists, waitUntilExists`

    - ### Methods inherited from interface com.hp.lft.sdk.TestObjectDescriber

      `describe`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilEnabledProvider

      `waitUntilEnabled, waitUntilEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.EnabledProvider

      `isEnabled`

    - ### Methods inherited from interface com.hp.lft.sdk.WaitUntilVisibleProvider

      `waitUntilVisible, waitUntilVisible`

    - ### Methods inherited from interface com.hp.lft.sdk.VisibleProvider

      `isVisible`

- - ### Method Detail

    - #### getPosition

          int getPosition()
                   throws GeneralLeanFtException

      Returns the scroll bar position.
      Returns:
        the scroll bar position
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setPosition

          void setPosition(int position)
                    throws GeneralLeanFtException

      Sets the scroll bar position.
      Parameters:
        `position` - the position
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextLine

          void nextLine(int numberOfLines)
                 throws GeneralLeanFtException

      Moves this scroll bar down the specified number of lines or emulates pressing the right arrow key the specified number of times.
      Parameters:
        `numberOfLines` - the number of lines to move the scroll bar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextLine

          void nextLine()
                 throws GeneralLeanFtException

      Moves the scroll bar downward a single lineor emulates pressing the right arrow key once.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextPage

          void nextPage(int numberOfPages)
                 throws GeneralLeanFtException

      Moves this scroll bar down or to the right the specified number of pages.
      Parameters:
        `numberOfPages` - the number of pages
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### nextPage

          void nextPage()
                 throws GeneralLeanFtException

      Moves the scroll bar down or to the right a single page.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousLine

          void previousLine(int numberOfLines)
                     throws GeneralLeanFtException

      Moves this scroll bar up the specified number of lines or emulates pressing the left arrow key the specified number of times.
      Parameters:
        `numberOfLines` - the number of lines
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousLine

          void previousLine()
                     throws GeneralLeanFtException

      Moves the scroll bar up or to the left a single line.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousPage

          void previousPage(int numberOfPages)
                     throws GeneralLeanFtException

      Moves the scroll bar up or to the left the specified number of pages.
      Parameters:
        `numberOfPages` - the number of pages to move the scroll bar
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### previousPage

          void previousPage()
                     throws GeneralLeanFtException

      Moves the scroll bar up or to the left a single page.
      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.