Interface ScrollPattern

```
public interface ScrollPattern
```
The methods and properties used to interact with a container control that can be scrolled.

Method Summary

Modifier and Type	Method and Description
`boolean`	`canScrollHorizontally()`
`boolean`	`canScrollVertically()`
`double`	`getHorizontalScrollPercent()`
`double`	`getHorizontalViewSize()`
`double`	`getVerticalScrollPercent()`
`double`	`getVerticalViewSize()`
`void`	`scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)` Scrolls the visible region of the content area horizontally and vertically.
`void`	`scrollHorizontal(ScrollAmount horizontalAmount)` Scrolls the visible region of the content area horizontally.
`void`	`scrollVertical(ScrollAmount verticalAmount)` Scrolls the visible region of the content area vertically.
`void`	`setHorizontalScrollPercent(double value)` Set the current horizontal scroll position.
`void`	`setScrollPercent(double horizontalPercent, double verticalPercent)` Sets the horizontal and/or vertical scroll position as a percentage of the total content area within the automation element.
`void`	`setVerticalScrollPercent(double value)` Set the current vertical scroll position.

- Method Detail
  - canScrollHorizontally
```
boolean canScrollHorizontally()
                       throws GeneralLeanFtException
```
    Returns:
    Indicates whether the UIA Pro element can scroll horizontally.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - canScrollVertically
```
boolean canScrollVertically()
                     throws GeneralLeanFtException
```
    Returns:
    Indicates whether the UIA Pro element can scroll vertically.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - getVerticalViewSize
```
double getVerticalViewSize()
                    throws GeneralLeanFtException
```
    Returns:
    The current vertical view size.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - getHorizontalViewSize
```
double getHorizontalViewSize()
                      throws GeneralLeanFtException
```
    Returns:
    The current horizontal view size.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - setVerticalScrollPercent
```
void setVerticalScrollPercent(double value)
                       throws GeneralLeanFtException
```
    Set the current vertical scroll position.
    Parameters:
    value - the current vertical scroll position.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - getVerticalScrollPercent
```
double getVerticalScrollPercent()
                         throws GeneralLeanFtException
```
    Returns:
    The current vertical scroll position.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - setHorizontalScrollPercent
```
void setHorizontalScrollPercent(double value)
                         throws GeneralLeanFtException
```
    Set the current horizontal scroll position.
    Parameters:
    value - the current horizontal scroll position.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - getHorizontalScrollPercent
```
double getHorizontalScrollPercent()
                           throws GeneralLeanFtException
```
    Returns:
    The current horizontal scroll position.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - scroll
```
void scroll(ScrollAmount horizontalAmount,
            ScrollAmount verticalAmount)
     throws GeneralLeanFtException
```
    Scrolls the visible region of the content area horizontally and vertically.
    Parameters:
    horizontalAmount - The horizontal increment specific to the control.
    verticalAmount - The vertical increment specific to the control.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - scrollHorizontal
```
void scrollHorizontal(ScrollAmount horizontalAmount)
               throws GeneralLeanFtException
```
    Scrolls the visible region of the content area horizontally.
    Parameters:
    horizontalAmount - The horizontal increment specific to the control.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - scrollVertical
```
void scrollVertical(ScrollAmount verticalAmount)
             throws GeneralLeanFtException
```
    Scrolls the visible region of the content area vertically.
    Parameters:
    verticalAmount - The vertical increment specific to the control.
    Throws:
    GeneralLeanFtException - if error occurs during execution.
  - setScrollPercent
```
void setScrollPercent(double horizontalPercent,
                      double verticalPercent)
               throws GeneralLeanFtException
```
    Sets the horizontal and/or vertical scroll position as a percentage of the total content area within the automation element.
    Parameters:
    horizontalPercent - The percentage of the total horizontal content area.
    verticalPercent - The percentage of the total vertical content area.
    Throws:
    GeneralLeanFtException - if error occurs during execution.

Interface ScrollPattern

Method Summary

Method Detail

canScrollHorizontally

canScrollVertically

getVerticalViewSize

getHorizontalViewSize

setVerticalScrollPercent

getVerticalScrollPercent

setHorizontalScrollPercent

getHorizontalScrollPercent

scroll

scrollHorizontal

scrollVertical

setScrollPercent

Send Help Center Feedback