[Root] / Xceed.Wpf.DataGrid Assembly / Xceed.Wpf.DataGrid Namespace / QueryItemsEventArgs Class


In This Topic
    QueryItemsEventArgs Class
    In This Topic
    Provides information on the DataGridVirtualizingCollectionView to which the grid is bound including the items that have been fetched from the underlying data source.
    Syntax
    'Declaration
     
    Public Class QueryItemsEventArgs 
       Inherits AsyncQueryEventArgs
    'Usage
     
    Dim instance As QueryItemsEventArgs
    public class QueryItemsEventArgs : AsyncQueryEventArgs 
    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.

    Inheritance Hierarchy

    System.Object
       System.EventArgs
          Xceed.Wpf.DataGrid.AsyncQueryEventArgs
             Xceed.Wpf.DataGrid.QueryItemsEventArgs

    Public Properties
     NameDescription
    Public PropertyGets an AsyncQueryInfo that provides the information necessary to retrieve the next batch of items.  
    Public PropertyGets the DataGridVirtualizingCollectionView to which the grid is bound.  
    Public Property

    Gets a read only collection of DataGridGroupInfo objects, which provide information on the parent groups.

     
    Public Propertytrue if the event is asynchronous, otherwise false. By default, true. (Inherited from Xceed.Wpf.DataGrid.AsyncQueryEventArgs)
    Top
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also