ComponentOne DataCollection
C1.DataCollection Assembly / C1.DataCollection Namespace / C1CursorDataCollection<T,K> Class / GetPageAsync Method
The index where the returned items will be inserted.
The token of the requesting page, pass null if no pages had been requested so far.
The desired number of items to be returned.
The sort descriptions.
The filter expression.
Cancellation token.

In This Topic
    GetPageAsync Method (C1CursorDataCollection<T,K>)
    In This Topic
    When overriden in an inherited class it returns the items in the page as well as a token to the next page.
    Syntax
    'Declaration
     
    Protected MustOverride Function GetPageAsync( _
       ByVal startingIndex As System.Integer, _
       ByVal pageToken As K, _
       Optional ByVal count As System.Nullable(Of Integer), _
       Optional ByVal sortDescriptions As System.Collections.Generic.IReadOnlyList(Of SortDescription), _
       Optional ByVal filterExpression As FilterExpression, _
       Optional ByVal cancellationToken As System.Threading.CancellationToken _
    ) As System.Threading.Tasks.Task(Of Tuple(Of K,IReadOnlyList(Of T)))
    protected abstract System.Threading.Tasks.Task<Tuple<K,IReadOnlyList<T>>> GetPageAsync( 
       System.int startingIndex,
       K pageToken,
       System.Nullable<int> count,
       System.Collections.Generic.IReadOnlyList<SortDescription> sortDescriptions,
       FilterExpression filterExpression,
       System.Threading.CancellationToken cancellationToken
    )

    Parameters

    startingIndex
    The index where the returned items will be inserted.
    pageToken
    The token of the requesting page, pass null if no pages had been requested so far.
    count
    The desired number of items to be returned.
    sortDescriptions
    The sort descriptions.
    filterExpression
    The filter expression.
    cancellationToken
    Cancellation token.

    Return Value

    A tuple containing the items and a token to the next page.
    See Also