319 lines
15 KiB
XML
319 lines
15 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>DevExtreme.AspNet.Data</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DevExtreme.AspNet.Data.Aggregation.Aggregator`1">
|
|
<summary>
|
|
Represents a data aggregator.
|
|
</summary>
|
|
<typeparam name="T">The type of the data items to be aggregated.</typeparam>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.Aggregation.Aggregator`1.Accessor">
|
|
<summary>
|
|
Allows reading data item properties.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Aggregation.Aggregator`1.#ctor(DevExtreme.AspNet.Data.Helpers.IAccessor{`0})">
|
|
<summary>
|
|
Initializes a new Aggregator class instance with an object that allows reading data item properties.
|
|
</summary>
|
|
<param name="accessor">An object that allows reading data item properties.</param>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Aggregation.Aggregator`1.Step(`0,System.String)">
|
|
<summary>
|
|
A callback invoked once for each data item.
|
|
</summary>
|
|
<param name="container">A data item.</param>
|
|
<param name="selector">The name or path to the property whose value should be aggregated.</param>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Aggregation.Aggregator`1.Finish">
|
|
<summary>
|
|
A callback invoked at the aggregation's final stage.
|
|
</summary>
|
|
<returns>The result of the aggregation.</returns>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.Aggregation.CustomAggregators">
|
|
<summary>
|
|
Provides methods that manipulate custom aggregators.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Aggregation.CustomAggregators.RegisterAggregator(System.String,System.Type)">
|
|
<summary>
|
|
Registers a custom aggregator.
|
|
</summary>
|
|
<param name="summaryType">The aggregator's string identifier.</param>
|
|
<param name="aggregatorType">The aggregator's type declaration without the generic type parameter T.</param>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.DataSourceLoader">
|
|
<summary>
|
|
Provides static methods for loading data from collections that implement the
|
|
<see cref="T:System.Collections.Generic.IEnumerable`1"/> or <see cref="T:System.Linq.IQueryable`1"/> interface.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.DataSourceLoader.Load``1(System.Collections.Generic.IEnumerable{``0},DevExtreme.AspNet.Data.DataSourceLoadOptionsBase)">
|
|
<summary>
|
|
Loads data from a collection that implements the <see cref="T:System.Collections.Generic.IEnumerable`1"/> interface.
|
|
</summary>
|
|
<typeparam name="T">The type of objects in the collection.</typeparam>
|
|
<param name="source">A collection that implements the <see cref="T:System.Collections.Generic.IEnumerable`1"/> interface.</param>
|
|
<param name="options">Data processing settings when loading data.</param>
|
|
<returns>The load result.</returns>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.DataSourceLoader.Load``1(System.Linq.IQueryable{``0},DevExtreme.AspNet.Data.DataSourceLoadOptionsBase)">
|
|
<summary>
|
|
Loads data from a collection that implements the <see cref="T:System.Linq.IQueryable`1"/> interface.
|
|
</summary>
|
|
<typeparam name="T">The type of objects in the collection.</typeparam>
|
|
<param name="source">A collection that implements the <see cref="T:System.Linq.IQueryable`1"/> interface.</param>
|
|
<param name="options">Data processing settings when loading data.</param>
|
|
<returns>The load result.</returns>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.DataSourceLoader.LoadAsync``1(System.Linq.IQueryable{``0},DevExtreme.AspNet.Data.DataSourceLoadOptionsBase,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Asynchronously loads data from a collection that implements the <see cref="T:System.Linq.IQueryable`1"/> interface.
|
|
</summary>
|
|
<typeparam name="T">The type of objects in the collection.</typeparam>
|
|
<param name="source">A collection that implements the <see cref="T:System.Linq.IQueryable`1"/> interface.</param>
|
|
<param name="options">Data processing settings when loading data.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> object that delivers a cancellation notice to the running operation.</param>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task`1"/> object that represents the asynchronous operation.
|
|
The task result contains the load result.
|
|
</returns>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase">
|
|
<summary>
|
|
A class with properties that specify data processing settings.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.StringToLowerDefault">
|
|
<summary>
|
|
A global default value for the <see cref="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.StringToLower" /> property
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.RequireTotalCount">
|
|
<summary>
|
|
A flag indicating whether the total number of data objects is required.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.RequireGroupCount">
|
|
<summary>
|
|
A flag indicating whether the number of top-level groups is required.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.IsCountQuery">
|
|
<summary>
|
|
A flag indicating whether the current query is made to get the total number of data objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Skip">
|
|
<summary>
|
|
The number of data objects to be skipped from the start of the resulting set.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Take">
|
|
<summary>
|
|
The number of data objects to be loaded.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Sort">
|
|
<summary>
|
|
A sort expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Group">
|
|
<summary>
|
|
A group expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Filter">
|
|
<summary>
|
|
A filter expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.TotalSummary">
|
|
<summary>
|
|
A total summary expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.GroupSummary">
|
|
<summary>
|
|
A group summary expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Select">
|
|
<summary>
|
|
A select expression.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.PreSelect">
|
|
<summary>
|
|
An array of data fields that limits the <see cref="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Select" /> expression.
|
|
The applied select expression is the intersection of <see cref="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.PreSelect" /> and <see cref="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.Select" />.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.RemoteSelect">
|
|
<summary>
|
|
A flag that indicates whether the LINQ provider should execute the select expression.
|
|
If set to false, the select operation is performed in memory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.RemoteGrouping">
|
|
<summary>
|
|
A flag that indicates whether the LINQ provider should execute grouping.
|
|
If set to false, the entire dataset is loaded and grouped in memory.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.PrimaryKey">
|
|
<summary>
|
|
An array of primary keys.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.DefaultSort">
|
|
<summary>
|
|
The data field to be used for sorting by default.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.StringToLower">
|
|
<summary>
|
|
A flag that indicates whether filter expressions should include a ToLower() call that makes string comparison case-insensitive.
|
|
Defaults to true for LINQ to Objects, false for any other provider.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.DataSourceLoadOptionsBase.PaginateViaPrimaryKey">
|
|
<summary>
|
|
If this flag is enabled, keys and data are loaded via separate queries. This may result in a more efficient SQL execution plan.
|
|
</summary>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.GroupingInfo">
|
|
<summary>
|
|
Represents a grouping level to be applied to data.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.GroupingInfo.GroupInterval">
|
|
<summary>
|
|
A value that groups data in ranges of a given length or date/time period.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.GroupingInfo.IsExpanded">
|
|
<summary>
|
|
A flag indicating whether the group's data objects should be returned.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.GroupingInfo.GetIsExpanded">
|
|
<summary>
|
|
Returns the value of the IsExpanded field or <c>true</c> if this value is <c>null</c>.
|
|
</summary>
|
|
<returns>The value of the IsExpanded field or <c>true</c> if this value is <c>null</c>.</returns>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.Helpers.DataSourceLoadOptionsParser">
|
|
<summary>
|
|
A parser for the data processing settings.
|
|
</summary>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Helpers.DataSourceLoadOptionsParser.Parse(DevExtreme.AspNet.Data.DataSourceLoadOptionsBase,System.Func{System.String,System.String})">
|
|
<summary>
|
|
Converts the string representations of the data processing settings to equivalent values of appropriate types.
|
|
</summary>
|
|
<param name="loadOptions">An object that will contain converted values.</param>
|
|
<param name="valueSource">A function that accepts names of the data source options (such as "filter", "sort", etc.) and returns corresponding values.</param>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.Helpers.IAccessor`1">
|
|
<summary>
|
|
Allows reading object properties.
|
|
</summary>
|
|
<typeparam name="T">The type of the object.</typeparam>
|
|
</member>
|
|
<member name="M:DevExtreme.AspNet.Data.Helpers.IAccessor`1.Read(`0,System.String)">
|
|
<summary>
|
|
Reads an object property.
|
|
</summary>
|
|
<param name="container">An object whose property should be read.</param>
|
|
<param name="selector">The name or path to the property.</param>
|
|
<returns>The property's value.</returns>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.ResponseModel.Group">
|
|
<summary>
|
|
Represents a group in the resulting dataset.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.Group.key">
|
|
<summary>
|
|
The group's key.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.Group.items">
|
|
<summary>
|
|
Subgroups or data objects.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.Group.count">
|
|
<summary>
|
|
The count of items in the group.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.Group.summary">
|
|
<summary>
|
|
Group summary calculation results.
|
|
</summary>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.ResponseModel.LoadResult">
|
|
<summary>
|
|
Represents a load result.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.LoadResult.data">
|
|
<summary>
|
|
A resulting dataset.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.LoadResult.totalCount">
|
|
<summary>
|
|
The total number of data objects in the resulting dataset.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.LoadResult.groupCount">
|
|
<summary>
|
|
The number of top-level groups in the resulting dataset.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.ResponseModel.LoadResult.summary">
|
|
<summary>
|
|
Total summary calculation results.
|
|
</summary>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.SortingInfo">
|
|
<summary>
|
|
Represents a sorting parameter.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.SortingInfo.Selector">
|
|
<summary>
|
|
The data field to be used for sorting.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.SortingInfo.Desc">
|
|
<summary>
|
|
A flag indicating whether data should be sorted in a descending order.
|
|
</summary>
|
|
</member>
|
|
<member name="T:DevExtreme.AspNet.Data.SummaryInfo">
|
|
<summary>
|
|
Represents a group or total summary definition.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.SummaryInfo.Selector">
|
|
<summary>
|
|
The data field to be used for calculating the summary.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DevExtreme.AspNet.Data.SummaryInfo.SummaryType">
|
|
<summary>
|
|
An aggregate function: "sum", "min", "max", "avg", or "count".
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|