Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.DataGrid.Toolkit Assembly / Xceed.Wpf.DataGrid Namespace / AsyncQueryInfo Class


In This Topic
    AsyncQueryInfo Class
    In This Topic
    Received in the QueryItems event to provide the information necessary to retrieve the next batch of items.
    Syntax
    'Declaration
 

    Public Class AsyncQueryInfo 
    'Usage
 

    Dim instance As AsyncQueryInfo
    public class AsyncQueryInfo
    Remarks
    The QueryItems event, which is raised whenever new records are required, allows the next batch of records to befetched 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 EndQuery method is called with an array that does not match the requested item count, the collection view will automatically refresh. If the array contains a a null reference (Nothing in Visual Basic), an exception will be thrown.
    Inheritance Hierarchy

    System.Object
       Xceed.Wpf.DataGrid.AsyncQueryInfo

    Public Properties
     NameDescription
    Public PropertyAsyncStateGets a user-defined object that qualifies or contains information about an asynchronous operation.  
    Public PropertyErrorGets or sets a user-defined object that qualifies or contains information about an error.  
    Public PropertyRequestedItemCountGets or sets a value representing the number of new items that should be returned.  
    Public PropertyShouldAbortGets a value indicating whether the operation should be aborted.  
    Public PropertyStartIndexGets or sets a value indicating the index in the data source at which to start retrieving the new items.  
    Top
    Public Methods
     NameDescription
    Public MethodDispose  
    Public MethodEndQueryCalled to provide new items.  
    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: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also

    Reference

    AsyncQueryInfo Members
    Xceed.Wpf.DataGrid Namespace

    Send Feedback