IScrollController Interface

Reference

Definition

Namespace:: Microsoft.UI.Xaml.Controls.Primitives

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Specifies a contract for scrollbar-like widgets that can set the scroll offsets of the content in a scrolling control.

public interface class IScrollController

/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.UI.Xaml.XamlContract, 327680)]
/// [Windows.Foundation.Metadata.Guid(1413048198, 5926, 21462, 151, 163, 64, 175, 8, 56, 49, 76)]
struct IScrollController

[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.XamlContract), 327680)]
[Windows.Foundation.Metadata.Guid(1413048198, 5926, 21462, 151, 163, 64, 175, 8, 56, 49, 76)]
public interface IScrollController

Public Interface IScrollController

Attributes: ContractVersionAttribute GuidAttribute

Properties

CanScroll	Gets a value that indicates whether the user can scroll or pan with the scroll controller.
IsScrollingWithMouse	Gets a value that indicates whether or not the scroll controller is handling a mouse-driven scroll.
PanningInfo	Gets an instance of an `IScrollControllerPanningInfo` implementation that contains information related to content panning, or `null`.

Methods

GetScrollAnimation(Int32, Vector2, Vector2, CompositionAnimation)	Provides the `IScrollController` with the option of customizing the animation used to perform its scroll request.
NotifyRequestedScrollCompleted(Int32)	Indicates that a scrolling operation initiated through a `ScrollToRequested`, `ScrollByRequested`, or `AddScrollVelocityRequested` event has completed.
SetIsScrollable(Boolean)	Sets a value that indicates whether or not the `ScrollPresenter` content is scrollable by means of user input.
SetValues(Double, Double, Double, Double)	Provides dimension information about the scrolling control to the scroll controller.

Events

AddScrollVelocityRequested	Occurs when a scroll velocity change is requested.
CanScrollChanged	Occurs when the `CanScroll` property value has changed.
IsScrollingWithMouseChanged	Occurs when the `IsScrollingWithMouse` property value changes.
ScrollByRequested	Occurs when a scroll by an particular offset delta is requested.
ScrollToRequested	Occurs when a scroll to a particular offset is requested.

Applies to