Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / WebApiDataSourceBuilder<TModel>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

WebApiDataSourceBuilder<TModel>

Class

Defines the fluent interface for configuring the DataSource WebApi create/update/destroy operation bindings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TModel

Syntax:
C#
public class WebApiDataSourceBuilder<TModel> : WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>> where TModel : class

Inheritance: objectWebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>WebApiDataSourceBuilder<TModel>

Derived Classes: FilterableWebApiDataSourceBuilder<TModel>

Inherited Members WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.dataSourceWebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.urlGeneratorWebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.viewContextWebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Events(Action<DataSourceEventBuilder>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Read(Action<CrudOperationBuilder>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Read(string)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Total(int)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.PageSize(int)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.AccentFoldingFiltering(string)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.ServerOperation(bool)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Sort(Action<DataSourceSortDescriptorFactory<TModel>>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Group(Action<DataSourceGroupDescriptorFactory<TModel>>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Aggregates(Action<DataSourceAggregateDescriptorFactory<TModel>>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Filter(Action<DataSourceFilterDescriptorFactory<TModel>>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Model(Action<DataSourceModelDescriptorFactory<TModel>>)WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.CaseSensitiveFiltering()WebApiDataSourceBuilderBase<TModel, WebApiDataSourceBuilder<TModel>>.Schema(Action<WebApiDataSourceSchemaBuilder>)object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

WebApiDataSourceBuilder(DataSource, ViewContext, IUrlGenerator)

C#
public WebApiDataSourceBuilder(DataSource dataSource, ViewContext viewContext, IUrlGenerator urlGenerator)
Parameters:dataSourceDataSourceviewContextViewContexturlGeneratorIUrlGenerator

Methods

AutoSync(bool)

Determines if data source would automatically sync any changes to its data items. By default changes are not automatically sync-ed.

C#
public virtual WebApiDataSourceBuilder<TModel> AutoSync(bool enabled)
Parameters:enabledbool

If true changes will be automatically synced, otherwise false.

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.AutoSync(true);
})
)

Create(Action<CrudOperationBuilder>)

Configures the URL for Create operation.

C#
public WebApiDataSourceBuilder<TModel> Create(Action<CrudOperationBuilder> configurator)
Parameters:configuratorAction<CrudOperationBuilder>

The Create configurator.

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Create(y=&gt;y.Action("Action", "Controller"));
})
)

Create(string)

Sets controller, action and routeValues for Create operation.

C#
public WebApiDataSourceBuilder<TModel> Create(string url)
Parameters:urlstring

Absolute or relative URL for the operation

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Create("url");
})
)

Destroy(Action<CrudOperationBuilder>)

Configures the URL for Destroy operation.

C#
public WebApiDataSourceBuilder<TModel> Destroy(Action<CrudOperationBuilder> configurator)
Parameters:configuratorAction<CrudOperationBuilder>

The Destroy configurator.

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Destroy(y=&gt;y.Action("Action", "Controller"));
})
)

Destroy(string)

Sets controller and action for Destroy operation.

C#
public WebApiDataSourceBuilder<TModel> Destroy(string url)
Parameters:urlstring

Absolute or relative URL for the operation

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Destroy("url");
})
)

Update(Action<CrudOperationBuilder>)

Configures the URL for Update operation.

C#
public WebApiDataSourceBuilder<TModel> Update(Action<CrudOperationBuilder> configurator)
Parameters:configuratorAction<CrudOperationBuilder>

The Update configurator.

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Update(y=&gt;y.Action("Action", "Controller"));
})
)

Update(string)

Sets controller, action and routeValues for Update operation.

C#
public WebApiDataSourceBuilder<TModel> Update(string url)
Parameters:urlstring

Absolute or relative URL for the operation

Returns:

WebApiDataSourceBuilder<TModel>

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.WebApi(x=&gt; {
x.Update("url");
})
)
In this article
DefinitionConstructorsWebApiDataSourceBuilder(DataSource, ViewContext, IUrlGenerator)MethodsAutoSync(bool)Create(Action<CrudOperationBuilder>)Create(string)Destroy(Action<CrudOperationBuilder>)Destroy(string)Update(Action<CrudOperationBuilder>)Update(string)
Not finding the help you need?
Contact Support