Package at.bestsolution.uia

Interface IScrollProvider

All Superinterfaces:
IInitable
public interface IScrollProvider extends IInitable
Provides access to controls that act as scrollable containers for a collection of child objects. The children of this control must implement IScrollItemProvider.

Implemented on a Microsoft UI Automation provider that must support the Scroll control pattern.

  • Method Details

    • get_HorizontallyScrollable

      boolean get_HorizontallyScrollable()
      Indicates whether the control can scroll horizontally.
      Returns:
      horzontal scrollable

    • get_HorizontalScrollPercent

      double get_HorizontalScrollPercent()
      Specifies the horizontal scroll position.

      The horizontal scroll position can be reported as UIA_ScrollPatternNoScroll if no valid position is available; for example, if the window does not have a horizontal scroll bar.

      Returns:
      the horzontal scroll percent

    • get_HorizontalViewSize

      double get_HorizontalViewSize()
      Specifies the horizontal size of the viewable region.
      Returns:
      the horizontal view size

    • get_VerticallyScrollable

      boolean get_VerticallyScrollable()
      Indicates whether the control can scroll vertically.
      Returns:
      vertically scrollable

    • get_VerticalScrollPercent

      double get_VerticalScrollPercent()
      Specifies the vertical scroll position.

      The vertical scroll position can be reported as UIA_ScrollPatternNoScroll if no valid position is available; for example, if the window does not have a vertical scroll bar.

      Returns:
      the vertical scroll percent

    • get_VerticalViewSize

      double get_VerticalViewSize()
      Specifies the vertical size of the viewable region.
      Returns:
      the vertical view size

    • Scroll

      void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)
      Scrolls the visible region of the content area horizontally and vertically.
      Parameters:
      horizontalAmount - the horzontal amount
      verticalAmount - the vertical amount

    • SetScrollPercent

      void SetScrollPercent(double horizontalPercent, double verticalPercent)
      Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.

      This method is only useful when the content area of the control is larger than the visible region.

      Parameters:
      horizontalPercent - The horizontal position as a percentage of the content area's total range, or UIA_ScrollPatternNoScroll if there is no horizontal scrolling.
      verticalPercent - The vertical position as a percentage of the content area's total range, or UIA_ScrollPatternNoScroll if there is no vertical scrolling.