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

CustomDataSourceBuilder<TModel>

Class

Provides a fluent interface for configuring custom data sources with strongly typed model support.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TModel

The type of the data model.

Syntax:

public class CustomDataSourceBuilder<TModel> : CustomDataSourceBuilderBase<CustomDataSourceBuilder<TModel>> where TModel : class

Inheritance: objectCustomDataSourceBuilderBase<CustomDataSourceBuilder<TModel>>CustomDataSourceBuilder<TModel>

Derived Classes: FilterableCustomDataSourceBuilder<TModel>

Constructors

CustomDataSourceBuilder(DataSource, ViewContext, IUrlGenerator)

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

Parameters:dataSourceDataSourceviewContextViewContexturlGeneratorIUrlGenerator

Methods

Aggregates(Action<DataSourceAggregateDescriptorFactory<TModel>>)

Configures the initial aggregates.

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

Parameters:aggregatesAction<DataSourceAggregateDescriptorFactory<TModel>>

The Aggregates set for the Custom DataSource

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Aggregates(aggregates =&gt;
{
aggregates.Add(p =&gt; p.UnitsInStock).Min().Max().Count();
aggregates.Add(p =&gt; p.UnitsOnOrder).Average();
aggregates.Add(p =&gt; p.ProductName).Count();
aggregates.Add(p =&gt; p.UnitPrice).Sum();
})
)

Filter(Action<DataSourceFilterDescriptorFactory<TModel>>)

Configures the initial filter.

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

Parameters:configuratorAction<DataSourceFilterDescriptorFactory<TModel>>

The lambda which configures the Filter Action

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Filter(f =&gt; f.Add(a =&gt; a.ShipName))
)

Group(Action<DataSourceGroupDescriptorFactory<TModel>>)

Configures the initial grouping.

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

Parameters:configuratorAction<DataSourceGroupDescriptorFactory<TModel>>

The lambda which configures the Group Action

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Group(s =&gt; s.Add(a =&gt;a.ShipName))
)

Schema(Action<CustomDataSourceSchemaBuilder<TModel>>)

Configures Schema properties

public CustomDataSourceBuilder<TModel> Schema(Action<CustomDataSourceSchemaBuilder<TModel>> configurator)

Parameters:configuratorAction<CustomDataSourceSchemaBuilder<TModel>>

The lambda which configures the Schema property

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Batch(true)
.PageSize(20)
.Schema(schema =&gt; schema.Model(m =&gt; m.Id(p =&gt; p.ProductID)))
.Transport(transport =&gt;
{
transport.Read(read =&gt;
read.Url("https://demos.telerik.com/service/v2/core/products")
.ContentType("application/json")
);
transport.Create(create =&gt;
create.Url("https://demos.telerik.com/service/v2/core/products/create")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.Update(update =&gt;
update.Url("https://demos.telerik.com/service/v2/core/products/update")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.Destroy(destroy =&gt;
destroy.Url("https://demos.telerik.com/service/v2/core/products/destroy")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.ParameterMap("parameterMap");
})
)

Sort(Action<DataSourceSortDescriptorFactory<TModel>>)

Configures the initial sorting.

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

Parameters:configuratorAction<DataSourceSortDescriptorFactory<TModel>>

The lambda which configures the Sort Action

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Sort(s =&gt; s.Add("ShipName"))
)

Transport(Action<CustomDataSourceTransportBuilder>)

Configures the transport of the DataSource

public CustomDataSourceBuilder<TModel> Transport(Action<CustomDataSourceTransportBuilder> configurator)

Parameters:configuratorAction<CustomDataSourceTransportBuilder>

The lambda which configures the Transport property

Returns:

CustomDataSourceBuilder<TModel>

Example:

.DataSource(dataSource =&gt; dataSource
.Custom()
.Batch(true)
.PageSize(20)
.Schema(schema =&gt; schema.Model(m =&gt; m.Id(p =&gt; p.ProductID)))
.Transport(transport =&gt;
{
transport.Read(read =&gt;
read.Url("https://demos.telerik.com/service/v2/core/products")
.ContentType("application/json")
);
transport.Create(create =&gt;
create.Url("https://demos.telerik.com/service/v2/core/products/create")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.Update(update =&gt;
update.Url("https://demos.telerik.com/service/v2/core/products/update")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.Destroy(destroy =&gt;
destroy.Url("https://demos.telerik.com/service/v2/core/products/destroy")
.ContentType("application/json")
.Type(HttpVerbs.Post)
);
transport.ParameterMap("parameterMap");
})
)