ReadOnlyWebApiDataSourceBuilder

Methods

Events(System.Action)

Configures the client-side events

Parameters

configurator - System.Action<DataSourceEventBuilder>

The events configuration.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                  x.Events(ev => ev.Change("onChange"));
                           })
               )

Read(System.Action)

Configures the URL for Read operation.

Parameters

configurator - System.Action<CrudOperationBuilder>

The read configuration.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                 x.Read(r=>r.Action("Action", "Controller"));
                           })
               )

Read(System.String)

Sets controller and action for Read operation.

Parameters

url - System.String

Absolute or relative URL for the operation

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                x.Read("url");
                           })
               )

Total(System.Int32)

Sets the total number of records in the data source. Required during Custom binding.

Parameters

total - System.Int32

Number of records

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                x.Total(10);
                           })
               )

PageSize(System.Int32)

Sets the number of records displayed on a single page.

Parameters

pageSize - System.Int32

The count of records per page.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                x.PageSize(10);
                           })
               )

AccentFoldingFiltering(System.String)

Configures whether diacritic filtering should be used.

Parameters

culture - System.String

The used culture.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                                x.AccentFoldingFiltering("de-DE");
                           })
               )

ServerOperation(System.Boolean)

Sets the operation mode of the DataSource. By default the DataSource will make a request to the server when data for paging, sorting, filtering or grouping is needed. If set to false all data will be requested through single request. Any other paging, sorting, filtering or grouping will be performed client-side.

Parameters

enabled - System.Boolean

True(default) if server operation mode is enabled, otherwise false.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.ServerOperation(true);
                           })
               )

Sort(System.Action)

Configures the initial sorting.

Parameters

configurator - System.Action<DataSourceSortDescriptorFactory>

The sort configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Sort(y=>y.Add("OrderID"));
                           })
               )

Group(System.Action)

Configures the initial grouping.

Parameters

configurator - System.Action<DataSourceGroupDescriptorFactory>

The group configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Group(y=>y.Add("OrderID", typeof(int)));
                           })
               )

Aggregates(System.Action)

The aggregates which are calculated when the data source populates with data.

Parameters

aggregates - System.Action<DataSourceAggregateDescriptorFactory>

The Aggregates configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Aggregates(y=>y.Add("OrderID", typeof(int)).Average());
                           })
               )

Filter(System.Action)

Configures the initial filter.

Parameters

configurator - System.Action<DataSourceFilterDescriptorFactory>

The Filter configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Filter(y=>y.Add(z=>z.ContactName != "Condition"));
                           })
               )

Model(System.Action)

Configures Model properties

Parameters

configurator - System.Action<DataSourceModelDescriptorFactory>

The Model configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Model(m => m.Id(id => id.OrderID));
                           })
               )

CaseSensitiveFiltering()

When enabled filtering is case sensitive

Example

            .DataSource(dataSource => dataSource
                .WebApi()
                .CaseSensitiveFiltering()
            )

Schema(System.Action)

Configures WebApi schema.

Parameters

configurator - System.Action<WebApiDataSourceSchemaBuilder>

The Schema configurator.

Example

               @(Html.Kendo().DataSource<OrderViewModel>()
                           .Name("ds")
                           .WebApi(x=> {
                               x.Schema(sch => sch.Data("Data"));
                           })
               )