TreeListView.ScrollAnimationMode Property

Gets or sets the per-pixel scrolling mode. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v23.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public ScrollAnimationMode ScrollAnimationMode { get; set; }

VB.NET

Public Property ScrollAnimationMode As ScrollAnimationMode

Property Value

Type	Description
ScrollAnimationMode	A ScrollAnimationMode enumeration value that specifies the per-pexel scrolling mode.

Available values:

Name	Description
EaseOut	Starts quickly and then decelerates.
Linear	Moves smoothly.
EaseInOut	Starts slowly, accelerates and then decelerates.
Custom	A custom animation effect implemented within the TableView.CustomScrollAnimation event handler (TreeListView.CustomScrollAnimation in TreeListView).

Remarks

To provide a visual effect for per-pixel scrolling, set the TreeListView.AllowScrollAnimation property to true. The ScrollAnimationMode and TreeListView.ScrollAnimationDuration properties allow you to customize the animation. The first property specifies the scrolling mode, the second property specifies the animation length.

Example

This example shows how to implement a custom animation displayed when a user vertically scrolls the GridControl (per-pixel scrolling):

1. Set the TableView.AllowScrollAnimation property to true.
2. Set the TableView.ScrollAnimationMode property to Custom.
3. Handle the TableView.CustomScrollAnimation event and specify a custom scroll animation.

View Example: Implement Custom Scroll Animation

XAML

<dxg:GridControl Name="grid" AutoGenerateColumns="AddNew">
    <dxg:GridControl.View>
        <dxg:TableView Name="view"
                       AutoWidth="True"
                       AllowScrollAnimation="True"
                       ScrollAnimationMode="Custom"
                       CustomScrollAnimation="view_CustomScrollAnimation"/>
    </dxg:GridControl.View>
</dxg:GridControl>

C#

void view_CustomScrollAnimation(object sender, DevExpress.Xpf.Grid.CustomScrollAnimationEventArgs e) {
    e.Storyboard = new Storyboard();
    DoubleAnimation animation = new DoubleAnimation {
        From = e.OldOffset,
        To = e.NewOffset,
        Duration = new Duration(TimeSpan.FromMilliseconds(600)),
        EasingFunction = new ExponentialEase() { Exponent = 0 }
    };
    e.Storyboard.Children.Add(animation);
}

VB.NET

Private Sub view_CustomScrollAnimation(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.CustomScrollAnimationEventArgs)
    e.Storyboard = New Storyboard()
    Dim animation As DoubleAnimation = New DoubleAnimation With {.From = e.OldOffset, .[To] = e.NewOffset, .Duration = New Duration(TimeSpan.FromMilliseconds(600)), .EasingFunction = New ExponentialEase() With {.Exponent = 0}}
    e.Storyboard.Children.Add(animation)
End Sub