TreeListView.CustomScrollAnimation Event

Enables you to provide custom animation played when grid data is vertically scrolled (per-pixel).

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event CustomScrollAnimationEventHandler CustomScrollAnimation

VB.NET

Public Event CustomScrollAnimation As CustomScrollAnimationEventHandler

Event Data

The CustomScrollAnimation event's data class is DevExpress.Xpf.Grid.CustomScrollAnimationEventArgs.

Remarks

The TreeListView.AllowPerPixelScrolling option must be set to true, and the TreeListView.ScrollAnimationMode property must be set to ScrollAnimationMode.Custom.

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