Scroll​Viewer​Automation​Peer Scroll​Viewer​Automation​Peer Scroll​Viewer​Automation​Peer 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
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Inherited properties

Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)Windows.UI.Xaml.Automation.Peers.AutomationPeer.RaiseTextEditTextChangedEvent(Windows.UI.Xaml.Automation.AutomationTextEditChangeType,Windows.Foundation.Collections.IVectorView<System.String>)

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.

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)

Initializes a new instance of the ScrollViewerAutomationPeer class.

public ScrollViewerAutomationPeer(ScrollViewer owner)public ScrollViewerAutomationPeer(ScrollViewer owner)Public Sub New(owner As ScrollViewer)
Parameters
owner
ScrollViewer ScrollViewer ScrollViewer

The ScrollViewer to create a peer for.

Attributes

Properties

HorizontallyScrollable HorizontallyScrollable HorizontallyScrollable

Gets a value that indicates whether the control can scroll horizontally.

public bool HorizontallyScrollable { get; }public bool HorizontallyScrollable { get; }Public ReadOnly Property HorizontallyScrollable As bool
Value
bool bool bool

true if the control can scroll horizontally; otherwise, false.

Attributes

HorizontalScrollPercent HorizontalScrollPercent HorizontalScrollPercent

Gets the current horizontal scroll position.

public double HorizontalScrollPercent { get; }public double HorizontalScrollPercent { get; }Public ReadOnly Property HorizontalScrollPercent As double
Value
double double double

The horizontal scroll position as a percentage of the total content area within the control.

Attributes

HorizontalViewSize HorizontalViewSize HorizontalViewSize

Gets the current horizontal view size.

public double HorizontalViewSize { get; }public double HorizontalViewSize { get; }Public ReadOnly Property HorizontalViewSize As double
Value
double double double

The horizontal size of the viewable region as a percentage of the total content area within the control.

Attributes

VerticallyScrollable VerticallyScrollable VerticallyScrollable

Gets a value that indicates whether the control can scroll vertically.

public bool VerticallyScrollable { get; }public bool VerticallyScrollable { get; }Public ReadOnly Property VerticallyScrollable As bool
Value
bool bool bool

true if the control can scroll vertically; otherwise, false.

Attributes

VerticalScrollPercent VerticalScrollPercent VerticalScrollPercent

Gets the current vertical scroll position.

public double VerticalScrollPercent { get; }public double VerticalScrollPercent { get; }Public ReadOnly Property VerticalScrollPercent As double
Value
double double double

The vertical scroll position as a percentage of the total content area within the control.

Attributes

VerticalViewSize VerticalViewSize VerticalViewSize

Gets the vertical view size.

public double VerticalViewSize { get; }public double VerticalViewSize { get; }Public ReadOnly Property VerticalViewSize As double
Value
double double double

The vertical size of the viewable region as a percentage of the total content area within the control.

Attributes

Methods

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
Parameters
horizontalAmount
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

The vertical increment that is specific to the control. Pass NoScroll if the control cannot be scrolled in this direction.

Attributes

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
Parameters
horizontalPercent
System.Double System.Double System.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
System.Double System.Double System.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.

Attributes

See Also