public interface IScrollProvider extends IInitable
Implemented on a Microsoft UI Automation provider that must support the Scroll control pattern.
Modifier and Type | Interface and Description |
---|---|
static class |
IScrollProvider.ScrollProviderContext
context object for IScrollProvider.
|
Modifier and Type | Method and Description |
---|---|
boolean |
get_HorizontallyScrollable()
Indicates whether the control can scroll horizontally.
|
double |
get_HorizontalScrollPercent()
Specifies the horizontal scroll position.
|
double |
get_HorizontalViewSize()
Specifies the horizontal size of the viewable region.
|
boolean |
get_VerticallyScrollable()
Indicates whether the control can scroll vertically.
|
double |
get_VerticalScrollPercent()
Specifies the vertical scroll position.
|
double |
get_VerticalViewSize()
Specifies the vertical size of the viewable region.
|
void |
Scroll(ScrollAmount horizontalAmount,
ScrollAmount verticalAmount)
Scrolls the visible region of the content area horizontally and vertically.
|
void |
SetScrollPercent(double horizontalPercent,
double verticalPercent)
Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.
|
initialize
boolean get_HorizontallyScrollable()
double get_HorizontalScrollPercent()
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.
double get_HorizontalViewSize()
boolean get_VerticallyScrollable()
double get_VerticalScrollPercent()
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.
double get_VerticalViewSize()
void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)
horizontalAmount
- the horzontal amountverticalAmount
- the vertical amountvoid SetScrollPercent(double horizontalPercent, double verticalPercent)
This method is only useful when the content area of the control is larger than the visible region.
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.