GridRowValidationEventArgs.CancellationToken Property

Gets an object that notifies that the Update operation should be canceled.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.1.Core.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public CancellationToken CancellationToken { get; protected set; }

VB.NET

Public Property CancellationToken As CancellationToken

Property Value

Type	Description
CancellationToken	An object that notifies that the Update operation should be canceled.

Remarks

Use the GridRowValidationEventArgs.UpdateRowResult property to specify a task that asynchronously posts changes to an underlying data source (database).

You can allow users to cancel the Update operation, for example, when they click the Cancel button. To do that, set the GridRowValidationEventArgs.UseCancellationToken property to true and use the GridRowValidationEventArgs.CancellationToken in a cancel function.

private void On_ValidateRow(object sender, GridRowValidationEventArgs e) {
    // ...
    e.UseCancellationToken = true;
    e.Register(() => DoSomethingToCancelOperation())
    e.ResultAsync = Task.Run(() => {
        // ...
        e.CancellationToken.ThrowIfCancellationRequested();
        // ...
    });
    // ...
}