Class
QueryableExtensions

Provides extension methods to process DataSourceRequest.

Definition

Namespace:Telerik.DataSource.Extensions

Assembly:Telerik.DataSource.dll

Syntax:

cs-api-definition
public static class QueryableExtensions

Inheritance: objectQueryableExtensions

Methods

Aggregate(IQueryable, IEnumerable<AggregateFunction>)

Calculates the results of given aggregates functions on a sequence of elements.

Declaration

cs-api-definition
public static AggregateResultCollection Aggregate(this IQueryable source, IEnumerable<AggregateFunction> aggregateFunctions)

Parameters

source

IQueryable

An IQueryable whose elements will be used for aggregate calculation.

aggregateFunctions

IEnumerable<AggregateFunction>

The aggregate functions.

Returns

AggregateResultCollection

Collection of AggregateResults calculated for each function.

Count(IQueryable)

Returns the number of elements in a sequence.

Declaration

cs-api-definition
public static int Count(this IQueryable source)

Parameters

source

IQueryable

The IQueryable that contains the elements to be counted.

Returns

int

The number of elements in the input sequence.

Exceptions

ArgumentNullException

source is null.

ElementAt(IQueryable, int)

Returns the element at a specified index in a sequence.

Declaration

cs-api-definition
public static object ElementAt(this IQueryable source, int index)

Parameters

source

IQueryable

An IQueryable to return an element from.

index

int

The zero-based index of the element to retrieve.

Returns

object

The element at the specified position in source.

Exceptions

ArgumentNullException

source is null.

ArgumentOutOfRangeException

index is less than zero.

GroupBy(IQueryable, IEnumerable<GroupDescriptor>, bool)

Groups the elements of a sequence according to a specified groupDescriptors.

Declaration

cs-api-definition
public static IQueryable GroupBy(this IQueryable source, IEnumerable<GroupDescriptor> groupDescriptors, bool includeItems = true)

Parameters

source

IQueryable

An IQueryable whose elements to group.

groupDescriptors

IEnumerable<GroupDescriptor>

The group descriptors used for grouping.

includeItems

bool

Returns

IQueryable

An IQueryable with IGroup items, whose elements contains a sequence of objects and a key.

GroupBy(IQueryable, IQueryable, IEnumerable<GroupDescriptor>, bool)

Declaration

cs-api-definition
public static IQueryable GroupBy(this IQueryable source, IQueryable notPagedData, IEnumerable<GroupDescriptor> groupDescriptors, bool includeItems = true)

Parameters

source

IQueryable

notPagedData

IQueryable

groupDescriptors

IEnumerable<GroupDescriptor>

includeItems

bool

Returns

IQueryable

GroupBy(IQueryable, LambdaExpression)

Groups the elements of a sequence according to a specified key selector function.

Declaration

cs-api-definition
public static IQueryable GroupBy(this IQueryable source, LambdaExpression keySelector)

Parameters

source

IQueryable

An IQueryable whose elements to group.

keySelector

LambdaExpression

A function to extract the key for each element.

Returns

IQueryable

An IQueryable with IGrouping<TKey, TElement> items, whose elements contains a sequence of objects and a key.

OrderBy(IQueryable, LambdaExpression)

Sorts the elements of a sequence in ascending order according to a key.

Declaration

cs-api-definition
public static IQueryable OrderBy(this IQueryable source, LambdaExpression keySelector)

Parameters

source

IQueryable

A sequence of values to order.

keySelector

LambdaExpression

A function to extract a key from an element.

Returns

IQueryable

An IQueryable whose elements are sorted according to a key.

OrderBy(IQueryable, LambdaExpression, ListSortDirection?)

Declaration

cs-api-definition
public static IQueryable OrderBy(this IQueryable source, LambdaExpression keySelector, ListSortDirection? sortDirection)

Parameters

source

IQueryable

The source.

keySelector

LambdaExpression

The key selector.

sortDirection

ListSortDirection?

The sort direction.

Returns

IQueryable

An IQueryable whose elements are sorted according to a key.

OrderByDescending(IQueryable, LambdaExpression)

Sorts the elements of a sequence in descending order according to a key.

Declaration

cs-api-definition
public static IQueryable OrderByDescending(this IQueryable source, LambdaExpression keySelector)

Parameters

source

IQueryable

A sequence of values to order.

keySelector

LambdaExpression

A function to extract a key from an element.

Returns

IQueryable

An IQueryable whose elements are sorted in descending order according to a key.

Page(IQueryable, int, int)

Pages through the elements of a sequence until the specified pageIndex using pageSize.

Declaration

cs-api-definition
public static IQueryable Page(this IQueryable source, int pageIndex, int pageSize)

Parameters

source

IQueryable

A sequence of values to page.

pageIndex

int

Index of the page.

pageSize

int

Size of the page.

Returns

IQueryable

An IQueryable whose elements are at the specified pageIndex.

Select(IQueryable, LambdaExpression)

Projects each element of a sequence into a new form.

Declaration

cs-api-definition
public static IQueryable Select(this IQueryable source, LambdaExpression selector)

Parameters

source

IQueryable

A sequence of values to project.

selector

LambdaExpression

A projection function to apply to each element.

Returns

IQueryable

An IQueryable whose elements are the result of invoking a projection selector on each element of source.

Skip(IQueryable, int)

Bypasses a specified number of elements in a sequence and then returns the remaining elements.

Declaration

cs-api-definition
public static IQueryable Skip(this IQueryable source, int count)

Parameters

source

IQueryable

An IQueryable to return elements from.

count

int

The number of elements to skip before returning the remaining elements.

Returns

IQueryable

An IQueryable that contains elements that occur after the specified index in the input sequence.

Exceptions

ArgumentNullException

source is null.

Sort(IQueryable, IEnumerable<SortDescriptor>)

Sorts the elements of a sequence using the specified sort descriptors.

Declaration

cs-api-definition
public static IQueryable Sort(this IQueryable source, IEnumerable<SortDescriptor> sortDescriptors)

Parameters

source

IQueryable

A sequence of values to sort.

sortDescriptors

IEnumerable<SortDescriptor>

The sort descriptors used for sorting.

Returns

IQueryable

An IQueryable whose elements are sorted according to a sortDescriptors.

Take(IQueryable, int)

Returns a specified number of contiguous elements from the start of a sequence.

Declaration

cs-api-definition
public static IQueryable Take(this IQueryable source, int count)

Parameters

source

IQueryable

The sequence to return elements from.

count

int

The number of elements to return.

Returns

IQueryable

An IQueryable that contains the specified number of elements from the start of source.

Exceptions

ArgumentNullException

source is null.

ToDataSourceResult(DataTable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty resullt.

Declaration

cs-api-definition
public static DataSourceResult ToDataSourceResult(this DataTable dataTable, DataSourceRequest request)

Parameters

dataTable

DataTable

An instance of DataTable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

DataSourceResult

A DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied.

ToDataSourceResult(IEnumerable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty result.

Declaration

cs-api-definition
public static DataSourceResult ToDataSourceResult(this IEnumerable enumerable, DataSourceRequest request)

Parameters

enumerable

IEnumerable

An instance of IEnumerable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

DataSourceResult

A DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied.

ToDataSourceResult(IQueryable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty result.

Declaration

cs-api-definition
public static DataSourceResult ToDataSourceResult(this IQueryable queryable, DataSourceRequest request)

Parameters

queryable

IQueryable

An instance of IQueryable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

DataSourceResult

A DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied.

ToDataSourceResult<TModel, TResult>(IEnumerable<TModel>, DataSourceRequest, Func<TModel, TResult>)

Declaration

cs-api-definition
public static DataSourceResult ToDataSourceResult<TModel, TResult>(this IEnumerable<TModel> enumerable, DataSourceRequest request, Func<TModel, TResult> selector)

Parameters

enumerable

IEnumerable<TModel>

request

DataSourceRequest

selector

Func<TModel, TResult>

Returns

DataSourceResult

ToDataSourceResult<TModel, TResult>(IQueryable<TModel>, DataSourceRequest, Func<TModel, TResult>)

Declaration

cs-api-definition
public static DataSourceResult ToDataSourceResult<TModel, TResult>(this IQueryable<TModel> enumerable, DataSourceRequest request, Func<TModel, TResult> selector)

Parameters

enumerable

IQueryable<TModel>

request

DataSourceRequest

selector

Func<TModel, TResult>

Returns

DataSourceResult

ToDataSourceResultAsync(DataTable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty resullt.

Declaration

cs-api-definition
public static Task<DataSourceResult> ToDataSourceResultAsync(this DataTable dataTable, DataSourceRequest request)

Parameters

dataTable

DataTable

An instance of DataTable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

Task<DataSourceResult>

A Task of DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied. It can be called with the "await" keyword for asynchronous operation.

ToDataSourceResultAsync(IEnumerable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty result.

Declaration

cs-api-definition
public static Task<DataSourceResult> ToDataSourceResultAsync(this IEnumerable enumerable, DataSourceRequest request)

Parameters

enumerable

IEnumerable

An instance of IEnumerable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

Task<DataSourceResult>

A Task of DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied. It can be called with the "await" keyword for asynchronous operation.

ToDataSourceResultAsync(IQueryable, DataSourceRequest)

Applies paging, sorting, filtering and grouping using the information from the DataSourceRequest object. If the collection is already paged, the method returns an empty result.

Declaration

cs-api-definition
public static Task<DataSourceResult> ToDataSourceResultAsync(this IQueryable queryable, DataSourceRequest request)

Parameters

queryable

IQueryable

An instance of IQueryable.

request

DataSourceRequest

An instance of DataSourceRequest.

Returns

Task<DataSourceResult>

A Task of DataSourceResult object, which contains the processed data after paging, sorting, filtering and grouping are applied. It can be called with the "await" keyword for asynchronous operation.

ToDataSourceResultAsync<TModel, TResult>(IEnumerable<TModel>, DataSourceRequest, Func<TModel, TResult>)

Declaration

cs-api-definition
public static Task<DataSourceResult> ToDataSourceResultAsync<TModel, TResult>(this IEnumerable<TModel> enumerable, DataSourceRequest request, Func<TModel, TResult> selector)

Parameters

enumerable

IEnumerable<TModel>

request

DataSourceRequest

selector

Func<TModel, TResult>

Returns

Task<DataSourceResult>

ToDataSourceResultAsync<TModel, TResult>(IQueryable<TModel>, DataSourceRequest, Func<TModel, TResult>)

Declaration

cs-api-definition
public static Task<DataSourceResult> ToDataSourceResultAsync<TModel, TResult>(this IQueryable<TModel> queryable, DataSourceRequest request, Func<TModel, TResult> selector)

Parameters

queryable

IQueryable<TModel>

request

DataSourceRequest

selector

Func<TModel, TResult>

Returns

Task<DataSourceResult>

Union(IQueryable, IQueryable)

Produces the set union of two sequences by using the default equality comparer.

Declaration

cs-api-definition
public static IQueryable Union(this IQueryable source, IQueryable second)

Parameters

source

IQueryable

An IQueryable whose distinct elements form the first set for the union.

second

IQueryable

An IQueryable whose distinct elements form the first set for the union.

Returns

IQueryable

An IQueryable that contains the elements from both input sequences, excluding duplicates.

Exceptions

ArgumentNullException

source is null.

Where(IQueryable, Expression)

Filters a sequence of values based on a predicate.

Declaration

cs-api-definition
public static IQueryable Where(this IQueryable source, Expression predicate)

Parameters

source

IQueryable

An IQueryable to filter.

predicate

Expression

A function to test each element for a condition.

Returns

IQueryable

An IQueryable that contains elements from the input sequence that satisfy the condition specified by predicate.

Where(IQueryable, IEnumerable<IFilterDescriptor>)

Filters a sequence of values based on a collection of IFilterDescriptor.

Declaration

cs-api-definition
public static IQueryable Where(this IQueryable source, IEnumerable<IFilterDescriptor> filterDescriptors)

Parameters

source

IQueryable

The source.

filterDescriptors

IEnumerable<IFilterDescriptor>

The filter descriptors.

Returns

IQueryable

An IQueryable that contains elements from the input sequence that satisfy the conditions specified by each filter descriptor in filterDescriptors.