Xceed DataGrid for WPF v7.2 Documentation
AsyncQueryInfo Property (QueryItemsEventArgs)


Xceed.Wpf.DataGrid Assembly > Xceed.Wpf.DataGrid Namespace > QueryItemsEventArgs Class : AsyncQueryInfo Property
Gets an AsyncQueryInfo that provides the information necessary to retrieve the next batch of items.
Syntax
'Declaration
 
Public ReadOnly Property AsyncQueryInfo As AsyncQueryInfo
'Usage
 
Dim instance As QueryItemsEventArgs

Dim value As AsyncQueryInfo

 

value = instance.AsyncQueryInfo
public AsyncQueryInfo AsyncQueryInfo {get;}

Property Value

An AsyncQueryInfo that provides the information necessary to retrieve the next batch of items.
Remarks

The QueryItems event, which is raised whenever new records are required, allows the next batch of records to be fetched from the data source and provided to the grid. New items are provided to the grid by calling the EndQuery method, which is exposed by the AsyncQueryInfo instance received in the event arguments of the QueryItems event, with an array of items. The StartIndex property of the AsyncQueryInfo indicates the index in the data source at which to start retrieving the new items while its RequestedItemCount property represents the number of new items that should be returned. The current state of the collection view (e.g., sorting and filtering) must always be taken into consideration when returning new items. If the EndQuerymethod is called with an array that does not match the requested item count, the collection view will automatically refresh. If the array contains a null(Nothing in Visual Basic) value, an exception will be thrown.

The EndQuery method is considered thread-safe and can therefore be called from another thread in order to leave the main UI thread responsive when retrieving new items.

Requirements

Target Platforms: Windows 11, Windows, 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

QueryItemsEventArgs Class
QueryItemsEventArgs Members