InfiniteAsyncSource Class

A virtual source component that allows you to bind the GridControl to a data source and display data with infinite scrolling.

Namespace: DevExpress.Xpf.Data

Assembly: DevExpress.Xpf.Core.v24.2.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public sealed class InfiniteAsyncSource :
    InfiniteSourceBase,
    IEditableCollectionView

VB.NET

Public NotInheritable Class InfiniteAsyncSource
    Inherits InfiniteSourceBase
    Implements IEditableCollectionView

Remarks

Run Demo: Infinite Scrolling Source

View Example: How to Bind to InfiniteAsyncSource

Read Tutorial: How to Use Virtual Sources Read Tutorial: How to Bind to a Custom Service with Restrictions

Workflow

The InfiniteAsyncSource raises events in the UI Thread and uses tasks to process data in parallel Working Threads. You should provide tasks to these events to obtain summaries, rows, etc. and enable the UI Thread to get data you fetched.

1. (Optional step) The InfiniteAsyncSource raises the InfiniteAsyncSource.GetTotalSummaries event. Handle this event and process summaries if you want to show them in the GridControl.
2. The InfiniteAsyncSource raises the InfiniteAsyncSource.FetchRows event to get the first portion of data.
3. When end users navigate to the next page, the InfiniteAsyncSource raises the InfiniteAsyncSource.FetchRows event to get the next portion of data.
4. (Optional step) When end users apply a filter, the InfiniteAsyncSource raises the InfiniteAsyncSource.GetUniqueValues event to get unique values and show them in a drop-down filter.

You can maintain a clean MVVM pattern and specify operations above in a ViewModel. To do this, create a command and bind it to the corresponding property:

Event	Property	Description
GetTotalSummaries	GetTotalSummariesCommand	Gets or sets a command that allows you to get total summaries.
FetchRows	FetchRowsCommand	Gets or sets a command that allows you to fetch rows.
GetUniqueValues	GetUniqueValuesCommand	Gets or sets a command that allows you to get unique values.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the InfiniteAsyncSource class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

XAML

wpf-data-grid-implement-crud-operations/CS/ViewModel/EFCore/InfiniteAsyncSource/MainWindow.xaml#L34

<dxg:GridControl.ItemsSource>
    <dx:InfiniteAsyncSource ElementType="local_issues:Issue" KeyProperty="Id"
                            FetchRowsCommand="{Binding FetchRowsCommand}" GetTotalSummariesCommand="{Binding GetTotalSummariesCommand}" />

how-to-bind-wpf-grid-to-data/CS/ViewModel/EFCore/InfiniteAsyncSource/MainWindow.xaml#L17

<dxg:GridControl.ItemsSource>
    <dx:InfiniteAsyncSource ElementType="local_issues:Issue" KeyProperty="Id"
                            FetchRowsCommand="{Binding FetchRowsCommand}" GetTotalSummariesCommand="{Binding GetTotalSummariesCommand}" />

wpf-data-grid-bind-to-infiniteasyncsource/CS/InfiniteAsyncSourceMVVMSample/MainWindow.xaml#L21

<dxg:GridControl.ItemsSource>
    <dx:InfiniteAsyncSource ElementType="{x:Type local:IssueData}"
                            FetchRowsCommand="{Binding FetchIssuesCommand}"

wpf-bind-gridcontrol-to-dynamic-data/CS/VirtualSources.InfiniteAsyncSource/MainWindow.xaml#L17

<dxg:GridControl.ItemsSource>
    <dx:InfiniteAsyncSource CustomProperties="{Binding CustomFields}" FetchRowsCommand="{Binding FetchRowsCommand}" />
</dxg:GridControl.ItemsSource>

Inheritance

Object

DispatcherObject

DependencyObject

ContentElement

FrameworkContentElement

DXFrameworkContentElement

VirtualSourceBase

InfiniteSourceBase

InfiniteAsyncSource