DataViewBase.DataSourceRefresh Event

Occurs before the data source is refreshed (a user presses F5 or executes the RefreshDataSource command) and allows you to implement custom refresh logic.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public event EventHandler<DataSourceRefreshEventArgs> DataSourceRefresh

VB.NET

Public Event DataSourceRefresh As EventHandler(Of DataSourceRefreshEventArgs)

Event Data

The DataSourceRefresh event's data class is DataSourceRefreshEventArgs. The following properties provide information specific to this event:

Property	Description
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RefreshAsync	Gets or sets a task that implements custom refresh logic.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

CRUD Operations

You can implement CRUD operations (create, read update, delete). These operations allow users to manage data in the Data Grid. Refer to the following topic for more information: Implement CRUD Operations in a Data-Bound Grid.

View Example: How to Implement CRUD Operations in a Data-Bound Grid

Related GitHub Examples

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

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/CodeBehind/EFCore/PagedAsyncSource/MainWindow.xaml#L23

    <dxg:TableView ShowUpdateRowButtons="OnCellEditorOpen" ValidateRow="OnValidateRow"
                   ShowFixedTotalSummary="True" DataSourceRefresh="OnDataSourceRefresh" />
</dxg:GridControl.View>

C#

wpf-data-grid-extend-crud-operations/CS/Undo/UndoCRUDOperationsBehavior.cs#L44

AssociatedObject.RowEditStarted += OnEditingStarted;
AssociatedObject.DataSourceRefresh += OnRefresh;
AssociatedObject.InitNewRow += OnNewRowStarted;

VB.NET

wpf-data-grid-extend-crud-operations/VB/Undo/UndoCRUDOperationsBehavior.vb#L70

AddHandler AssociatedObject.RowEditStarted, AddressOf OnEditingStarted
AddHandler AssociatedObject.DataSourceRefresh, AddressOf OnRefresh
AddHandler AssociatedObject.InitNewRow, AddressOf OnNewRowStarted