New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

WebApiDataSourceBuilderBase<TModel, TDataSourceBuilder>

Class

Defines the fluent interface for configuring the DataSource options.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TModel

TDataSourceBuilder

Syntax:

public abstract class WebApiDataSourceBuilderBase<TModel, TDataSourceBuilder> where TModel : class where TDataSourceBuilder : WebApiDataSourceBuilderBase<TModel, TDataSourceBuilder>

Inheritance: objectWebApiDataSourceBuilderBase<TModel, TDataSourceBuilder>

Derived Classes: ReadOnlyWebApiDataSourceBuilder<TModel>WebApiDataSourceBuilder<TModel>

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

WebApiDataSourceBuilderBase(DataSource, ViewContext, IUrlGenerator)

public WebApiDataSourceBuilderBase(DataSource dataSource, ViewContext viewContext, IUrlGenerator urlGenerator)

Parameters:dataSourceDataSourceviewContextViewContexturlGeneratorIUrlGenerator

Fields

dataSource

DataSource

protected readonly DataSource dataSource

urlGenerator

IUrlGenerator

protected readonly IUrlGenerator urlGenerator

viewContext

ViewContext

protected readonly ViewContext viewContext

Methods

AccentFoldingFiltering(string)

Configures whether diacritic filtering should be used.

public TDataSourceBuilder AccentFoldingFiltering(string culture)

Parameters:culturestring

The used culture.

Returns:

TDataSourceBuilder

Example:

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

Aggregates(Action<DataSourceAggregateDescriptorFactory<TModel>>)

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

public virtual TDataSourceBuilder Aggregates(Action<DataSourceAggregateDescriptorFactory<TModel>> aggregates)

Parameters:aggregatesAction<DataSourceAggregateDescriptorFactory<TModel>>

The Aggregates configurator.

Returns:

TDataSourceBuilder

Example:

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

CaseSensitiveFiltering()

When enabled filtering is case sensitive

public virtual TDataSourceBuilder CaseSensitiveFiltering()

Returns:

TDataSourceBuilder

Example:

.DataSource(dataSource =&gt; dataSource
.WebApi()
.CaseSensitiveFiltering()
)

Events(Action<DataSourceEventBuilder>)

Configures the client-side events

public TDataSourceBuilder Events(Action<DataSourceEventBuilder> configurator)

Parameters:configuratorAction<DataSourceEventBuilder>

The events configuration.

Returns:

TDataSourceBuilder

Example:

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

Filter(Action<DataSourceFilterDescriptorFactory<TModel>>)

Configures the initial filter.

public virtual TDataSourceBuilder Filter(Action<DataSourceFilterDescriptorFactory<TModel>> configurator)

Parameters:configuratorAction<DataSourceFilterDescriptorFactory<TModel>>

The Filter configurator.

Returns:

TDataSourceBuilder

Example:

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

Group(Action<DataSourceGroupDescriptorFactory<TModel>>)

Configures the initial grouping.

public virtual TDataSourceBuilder Group(Action<DataSourceGroupDescriptorFactory<TModel>> configurator)

Parameters:configuratorAction<DataSourceGroupDescriptorFactory<TModel>>

The group configurator.

Returns:

TDataSourceBuilder

Example:

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

Model(Action<DataSourceModelDescriptorFactory<TModel>>)

Configures Model properties

public virtual TDataSourceBuilder Model(Action<DataSourceModelDescriptorFactory<TModel>> configurator)

Parameters:configuratorAction<DataSourceModelDescriptorFactory<TModel>>

The Model configurator.

Returns:

TDataSourceBuilder

Example:

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

PageSize(int)

Sets the number of records displayed on a single page.

public TDataSourceBuilder PageSize(int pageSize)

Parameters:pageSizeint

The count of records per page.

Returns:

TDataSourceBuilder

Example:

@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.PageSize(10);
})
)

Read(Action<CrudOperationBuilder>)

Configures the URL for Read operation.

public TDataSourceBuilder Read(Action<CrudOperationBuilder> configurator)

Parameters:configuratorAction<CrudOperationBuilder>

The read configuration.

Returns:

TDataSourceBuilder

Example:

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

Read(string)

Sets controller and action for Read operation.

public TDataSourceBuilder Read(string url)

Parameters:urlstring

Absolute or relative URL for the operation

Returns:

TDataSourceBuilder

Example:

@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Read("url");
})
)

Schema(Action<WebApiDataSourceSchemaBuilder>)

Configures WebApi schema.

public virtual TDataSourceBuilder Schema(Action<WebApiDataSourceSchemaBuilder> configurator)

Parameters:configuratorAction<WebApiDataSourceSchemaBuilder>

The Schema configurator.

Returns:

TDataSourceBuilder

Example:

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

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.

public TDataSourceBuilder ServerOperation(bool enabled)

Parameters:enabledbool

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

Returns:

TDataSourceBuilder

Example:

@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.ServerOperation(true);
})
)

Sort(Action<DataSourceSortDescriptorFactory<TModel>>)

Configures the initial sorting.

public virtual TDataSourceBuilder Sort(Action<DataSourceSortDescriptorFactory<TModel>> configurator)

Parameters:configuratorAction<DataSourceSortDescriptorFactory<TModel>>

The sort configurator.

Returns:

TDataSourceBuilder

Example:

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

Total(int)

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

public TDataSourceBuilder Total(int total)

Parameters:totalint

Number of records

Returns:

TDataSourceBuilder

Example:

@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Total(10);
})
)