All docs
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

FederationDataSource.FillAsync(CancellationToken) Method

Populates the FederationDataSource in an asynchronous manner and uses the cancellationToken parameter to send the cancellation signal.

Namespace: DevExpress.DataAccess.DataFederation

Assembly: DevExpress.DataAccess.v20.2.dll


public Task FillAsync(
    CancellationToken cancellationToken
Public Function FillAsync(
    cancellationToken As CancellationToken
) As Task


Name Type Description
cancellationToken CancellationToken

A cancellation token that the task observes.


Type Description

A task that populates the data source.


Use this method to populate a federated data source in an individual task asynchronously. Unlike the Fill() method call, FillAsync does not lock other actions performed concurrently. For instance, the user interface remains operational while the data source is populated.

Call the FillAsync method with the await operator.

The cancellationToken parameter provides a way to send the cancellation signal to the task. The task monitors the token and stops when it receives the signal. Create a CancellationTokenSource class instance and pass its Token property to the FillAsync method call. Call the CancellationTokenSource.Cancel method to stop the task.


The code sample below creates a federated data source. A CancellationTokenSource class instance is used to allow users to interrupt the data source fill process if it takes too long.

using System.Threading;
using System.Threading.Tasks;
using DevExpress.DataAccess;
using DevExpress.DataAccess.Sql;
using DevExpress.DataAccess.Excel;
using DevExpress.DataAccess.DataFederation;
using DevExpress.DataAccess.ObjectBinding;
using DevExpress.DataAccess.ConnectionParameters;
// ...
// Create and configure an SQL data source.
SqlDataSource sqlDataSource = new SqlDataSource(new Access97ConnectionParameters(Path.Combine(Path.GetDirectoryName(typeof(ReportCreator).Assembly.Location), "Data/nwind.mdb"), "", "")) { Name = "Sql_Categories" };
var CategoriesQuery = SelectQueryFluentBuilder

// Create and configure an Excel data source.
ExcelDataSource excelDataSource = new ExcelDataSource() { Name = "Excel_Products" };
excelDataSource.FileName = Path.Combine(Path.GetDirectoryName(typeof(Form1).Assembly.Location), "Data/Products.xlsx");
excelDataSource.SourceOptions = new ExcelSourceOptions() {
    ImportSettings = new ExcelWorksheetSettings("Sheet"),

// Create and configure a federated data source.
FederationDataSource federationDataSource = new FederationDataSource();

Source sourceCategories = new Source(SqlDataSource.Name, sqlDataSource, "Categories");
Source sourceProducts = new Source(excelDataSource.Name, excelDataSource, "Products");

SelectNode selectNode = sourceCategories.From().Select("CategoryName")
    .Join(excelDataSource, "[Excel_Products.CategoryID] = [Sql_Categories.CategoryID]")
    .Select("CategoryID", "ProductName", "UnitPrice")

SelectNode ordersQuery = sourceHeader.From().Select("OrderID", "Status", "Description")
    .Join(sourceOrderDetail, "[OrderHeader.OrderID] = [OrderDetail.OrderID]")
    .Select("Quantity", "Extended Price")

// Populate the data source.
await federationDataSource.FillAsync(cancellationTokenSource.Token);
See Also