ScrollViewerAutomationPeer
ScrollViewerAutomationPeer
ScrollViewerAutomationPeer
ScrollViewerAutomationPeer
Class
Definition
Exposes ScrollViewer types to Microsoft UI Automation.
public : class ScrollViewerAutomationPeer : FrameworkElementAutomationPeer, IScrollViewerAutomationPeer, IScrollProviderpublic class ScrollViewerAutomationPeer : FrameworkElementAutomationPeer, IScrollViewerAutomationPeer, IScrollProviderPublic Class ScrollViewerAutomationPeer Inherits FrameworkElementAutomationPeer Implements IScrollViewerAutomationPeer, IScrollProvider// This API is not available in Javascript.
- Inheritance
-
FrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerFrameworkElementAutomationPeerScrollViewerAutomationPeerScrollViewerAutomationPeerScrollViewerAutomationPeerScrollViewerAutomationPeer
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Inherited Members
Inherited methods
Inherited properties
Remarks
The Windows Runtime ScrollViewer class creates a new ScrollViewerAutomationPeer as its OnCreateAutomationPeer definition. ScrollViewer is sealed, so the normal scenario of deriving from the ScrollViewer class and its existing peer isn't applicable to ScrollViewerAutomationPeer.
Default peer implementation and overrides in ScrollViewerAutomationPeer
ScrollViewerAutomationPeer has overrides of Core methods such that the associated AutomationPeer methods provide peer-specific information to a Microsoft UI Automation client.
- GetPattern reports that the peer provides pattern support for PatternInterface.Scroll (IScrollProvider ).
- GetClassName returns "ScrolViewer".
- GetAutomationControlType returns AutomationControlType.Pane.
- IsControlElement returns a value based on the template parent. If there is a template parent then it returns true, otherwise the value is false. The scenario here is that a templated control may have forwarded to this peer for scrolling support, but normally a ScrollViewer by itself isn't a full-fledged control. This peer fires several automation events on behalf of its owner in response to changes in scrolling or properties that report scrolling info.
The peer also has other behaviors that are provided by the base FrameworkElementAutomationPeer class. For more info, see "Base implementation in FrameworkElementAutomationPeer" section of Custom automation peers.
Constructors
ScrollViewerAutomationPeer(ScrollViewer) ScrollViewerAutomationPeer(ScrollViewer) ScrollViewerAutomationPeer(ScrollViewer) ScrollViewerAutomationPeer(ScrollViewer)
Initializes a new instance of the ScrollViewerAutomationPeer class.
public : ScrollViewerAutomationPeer(ScrollViewer owner)public ScrollViewerAutomationPeer(ScrollViewer owner)Public Sub New(owner As ScrollViewer)// This API is not available in Javascript.
The ScrollViewer to create a peer for.
Properties
HorizontallyScrollable HorizontallyScrollable HorizontallyScrollable HorizontallyScrollable
Gets a value that indicates whether the control can scroll horizontally.
public : PlatForm::Boolean HorizontallyScrollable { get; }public bool HorizontallyScrollable { get; }Public ReadOnly Property HorizontallyScrollable As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the control can scroll horizontally; otherwise, false.
HorizontalScrollPercent HorizontalScrollPercent HorizontalScrollPercent HorizontalScrollPercent
Gets the current horizontal scroll position.
public : double HorizontalScrollPercent { get; }public double HorizontalScrollPercent { get; }Public ReadOnly Property HorizontalScrollPercent As double// This API is not available in Javascript.
- Value
- double double double double
The horizontal scroll position as a percentage of the total content area within the control.
HorizontalViewSize HorizontalViewSize HorizontalViewSize HorizontalViewSize
Gets the current horizontal view size.
public : double HorizontalViewSize { get; }public double HorizontalViewSize { get; }Public ReadOnly Property HorizontalViewSize As double// This API is not available in Javascript.
- Value
- double double double double
The horizontal size of the viewable region as a percentage of the total content area within the control.
VerticallyScrollable VerticallyScrollable VerticallyScrollable VerticallyScrollable
Gets a value that indicates whether the control can scroll vertically.
public : PlatForm::Boolean VerticallyScrollable { get; }public bool VerticallyScrollable { get; }Public ReadOnly Property VerticallyScrollable As bool// This API is not available in Javascript.
- Value
- PlatForm::Boolean bool bool bool
true if the control can scroll vertically; otherwise, false.
VerticalScrollPercent VerticalScrollPercent VerticalScrollPercent VerticalScrollPercent
Gets the current vertical scroll position.
public : double VerticalScrollPercent { get; }public double VerticalScrollPercent { get; }Public ReadOnly Property VerticalScrollPercent As double// This API is not available in Javascript.
- Value
- double double double double
The vertical scroll position as a percentage of the total content area within the control.
VerticalViewSize VerticalViewSize VerticalViewSize VerticalViewSize
Gets the vertical view size.
public : double VerticalViewSize { get; }public double VerticalViewSize { get; }Public ReadOnly Property VerticalViewSize As double// This API is not available in Javascript.
- Value
- double double double double
The vertical size of the viewable region as a percentage of the total content area within the control.
Methods
Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount) Scroll(ScrollAmount, ScrollAmount)
Scrolls the visible region of the content area horizontally, vertically, or both.
public : void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)public void Scroll(ScrollAmount horizontalAmount, ScrollAmount verticalAmount)Public Function Scroll(horizontalAmount As ScrollAmount, verticalAmount As ScrollAmount) As void// This API is not available in Javascript.
- horizontalAmount
- ScrollAmount ScrollAmount ScrollAmount ScrollAmount
The horizontal increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.
- verticalAmount
- ScrollAmount ScrollAmount ScrollAmount ScrollAmount
The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.
SetScrollPercent(Double, Double) SetScrollPercent(Double, Double) SetScrollPercent(Double, Double) SetScrollPercent(Double, Double)
Sets the horizontal and vertical scroll position as a percentage of the total content area within the control.
public : void SetScrollPercent(double horizontalPercent, double verticalPercent)public void SetScrollPercent(Double horizontalPercent, Double verticalPercent)Public Function SetScrollPercent(horizontalPercent As Double, verticalPercent As Double) As void// This API is not available in Javascript.
- horizontalPercent
- double Double Double Double
The horizontal position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.
- verticalPercent
- double Double Double Double
The vertical position as a percentage of the content area's total range. Pass NoScroll if the control cannot be scrolled in this direction.