IScrollController.GetScrollAnimation Method

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

Provides the IScrollController with the option of customizing the animation used to perform its scroll request.

public:
 CompositionAnimation ^ GetScrollAnimation(int correlationId, float2 startPosition, float2 endPosition, CompositionAnimation ^ defaultAnimation);

CompositionAnimation GetScrollAnimation(int const& correlationId, float2 const& startPosition, float2 const& endPosition, CompositionAnimation const& defaultAnimation);

public CompositionAnimation GetScrollAnimation(int correlationId, Vector2 startPosition, Vector2 endPosition, CompositionAnimation defaultAnimation);

function getScrollAnimation(correlationId, startPosition, endPosition, defaultAnimation)

Public Function GetScrollAnimation (correlationId As Integer, startPosition As Vector2, endPosition As Vector2, defaultAnimation As CompositionAnimation) As CompositionAnimation

Parameters

correlationId: Int32
int

A correlation ID number used to associate a method call with corresponding events.

startPosition: Vector2 Vector2
float2

The start position of the content.

endPosition: Vector2 Vector2
float2

The end position of the content.

defaultAnimation: CompositionAnimation

The animation that is applied to the scroll request.

Returns

CompositionAnimation

The animation to use, if any, or null.

Remarks

This animation returned by this method can be:

the defaultAnimation, either unchanged or modified
a brand-new custom animation
null.

Applies to

Share via