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

DataSourceWidgetBuilder<T>

Class

Defines the fluent API for configuring the Telerik UI for ASP.NET MVC DataSource

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

Syntax:
C#
public class DataSourceWidgetBuilder<T> : WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>, IHtmlString where T : class

Inheritance: objectWidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>DataSourceWidgetBuilder<T>

Implements: IHtmlString

Inherited Members WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ToComponent()WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.Name(string)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.Deferred(bool)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ModelMetadata(ModelMetadata)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.HtmlAttributes(object)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.AsModule(bool)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.Render()WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ScriptAttributes(object, bool)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ToHtmlString()WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ToClientTemplate()WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.ToString()WidgetBuilderBase<DataSourceWidget<T>, DataSourceWidgetBuilder<T>>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

DataSourceWidgetBuilder(DataSourceWidget<T>)

Gets the view component.

C#
public DataSourceWidgetBuilder(DataSourceWidget<T> component)
Parameters:componentDataSourceWidget<T>

Fields

urlGenerator

C#
protected readonly IUrlGenerator urlGenerator

Methods

Ajax(Action<AjaxDataSourceBuilder<T>>)

Configures the DataSource for Ajax data binding.

C#
public DataSourceWidgetBuilder<T> Ajax(Action<AjaxDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<AjaxDataSourceBuilder<T>>

The action that configures the Ajax data binding settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().DataSource&lt;ProductViewModel&gt;()
.Name("dataSource1")
.Ajax(dataSource =&gt; dataSource
.PageSize(10)
.Read(read =&gt; read.Action("Read", "Home"))
)
)

Custom(Action<CustomDataSourceBuilder<T>>)

Configures a custom DataSource.

C#
public DataSourceWidgetBuilder<T> Custom(Action<CustomDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<CustomDataSourceBuilder<T>>

The action that configures the custom data binding settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().DataSource&lt;ProductViewModel&gt;()
.Name("myDataSource")
.Custom(dataSource =&gt; dataSource
.Type("odata")
.ServerPaging(true)
.PageSize(10)
.Transport(transport =&gt;
{
transport.Read(read =&gt; read.Url("myURL").DataType("jsonp"));
})
)
)

Gantt(Action<GanttDataSourceBuilder<T>>)

Configures the DataSource of the Gantt component.

C#
public DataSourceWidgetBuilder<T> Gantt(Action<GanttDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<GanttDataSourceBuilder<T>>

The action that configures the Gantt DataSource settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().Gantt&lt;TaskViewModel, DependencyViewModel&gt;()
.Name("gantt")
...
.DataSource(d =&gt; d
.Model(m =&gt;
{
m.Id(f =&gt; f.TaskID);
m.ParentId(f =&gt; f.ParentID);
})
.Read("ReadTasks", "Gantt")
.Destroy("DestroyTask", "Gantt")
.Update("UpdateTask", "Gantt")
.Create("CreateTask", "Gantt")
)
)

GanttDependency(Action<GanttDependenciesDataSourceBuilder<T>>)

Configures the DataSource for the dependencies of the Gantt component tasks.

C#
public DataSourceWidgetBuilder<T> GanttDependency(Action<GanttDependenciesDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<GanttDependenciesDataSourceBuilder<T>>

The action that configures the DependenciesDataSource settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().Gantt&lt;TaskViewModel, DependencyViewModel&gt;()
.Name("gantt")
...
.DependenciesDataSource(d =&gt; d
.Model(m =&gt;
{
m.Id(f =&gt; f.DependencyID);
m.PredecessorId(f =&gt; f.PredecessorID);
m.SuccessorId(f =&gt; f.SuccessorID);
})
.Read("ReadDependencies", "Gantt")
.Create("CreateDependency", "Gantt")
.Destroy("DestroyDependency", "Gantt")
)
)

Hierarchical(Action<HierarchicalDataSourceBuilder<T>>)

Configures the Hierarchical DataSource that allows the representation of hierarchical data.

C#
public DataSourceWidgetBuilder<T> Hierarchical(Action<HierarchicalDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<HierarchicalDataSourceBuilder<T>>

The action that configures the Hierarchical DataSource settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().TreeView()
.Name("treeview")
.DataTextField("Name")
.DataSource(dataSource =&gt; dataSource
.Read(read =&gt; read
.Action("Read", "TreeView")
)
)
)

Pivot(Action<PivotDataSourceBuilder<T>>)

Configures the DataSource of the PivotGrid component.

C#
public DataSourceWidgetBuilder<T> Pivot(Action<PivotDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<PivotDataSourceBuilder<T>>

The action that configures the PivotGrid DataSource settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().PivotGrid&lt;CustomerViewModel&gt;()
.Name("pivotgrid")
...
.DataSource(dataSource =&gt; dataSource
.Ajax()
.Transport(transport =&gt; transport.Read("ReadData", "PivotGrid"))
.Schema(schema =&gt; schema
.Cube(cube =&gt; cube
.Dimensions(dimensions =&gt; {
dimensions.Add(model =&gt; model.ContactName).Caption("All Contacts");
dimensions.Add(model =&gt; model.CompanyName).Caption("All Companies");
})
.Measures(measures =&gt; measures.Add("Contacts Count").Field(model =&gt; model.CustomerID).AggregateName("count"))
))
.Columns(columns =&gt;
{
columns.Add("Country").Expand(false);
columns.Add("CompanyName");
})
.Rows(rows =&gt; rows.Add("ContactTitle").Expand(false))
.Measures(measures =&gt; measures.Values("Contacts Count"))
)
)

Scheduler(Action<SchedulerAjaxDataSourceBuilder<T>>)

Configures the DataSource of the Scheduler component.

C#
public DataSourceWidgetBuilder<T> Scheduler(Action<SchedulerAjaxDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<SchedulerAjaxDataSourceBuilder<T>>

The action that configures the Scheduler DataSource settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().Scheduler&lt;TaskViewModel&gt;()
.Name("scheduler")
...
.DataSource(d =&gt; d
.Model(m =&gt;
{
m.Id(f =&gt; f.TaskID);
})
.Read("Read", "Scheduler")
.Create("Create", "Scheduler")
.Destroy("Destroy", "Scheduler")
.Update("Update", "Scheduler")
)
)

SignalR(Action<SignalRDataSourceBuilder<T>>)

Configures the DataSource SignalR binding.

C#
public DataSourceWidgetBuilder<T> SignalR(Action<SignalRDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<SignalRDataSourceBuilder<T>>

The action that configures the SignalR binding settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().Grid&lt;ProductViewModel&gt;()
.Name("grid")
...
.DataSource(dataSource =&gt; dataSource
.SignalR()
.PageSize(20)
.Transport(tr =&gt; tr
.Promise("hubStart")
.Hub("hub")
.Client(c =&gt; c
.Read("read")
.Create("create")
.Update("update")
.Destroy("destroy"))
.Server(s =&gt; s
.Read("read")
.Create("create")
.Update("update")
.Destroy("destroy")))
.Schema(schema =&gt; schema
.Model(model =&gt;
{
model.Id("ID");
model.Field("ID", typeof(int)).Editable(false);
}))
)
)

TreeList(Action<TreeListAjaxDataSourceBuilder<T>>)

C#
public DataSourceWidgetBuilder<T> TreeList(Action<TreeListAjaxDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<TreeListAjaxDataSourceBuilder<T>>Returns:

DataSourceWidgetBuilder<T>

WebApi(Action<WebApiDataSourceBuilder<T>>)

Configures the DataSource for WebAPI data binding.

C#
public DataSourceWidgetBuilder<T> WebApi(Action<WebApiDataSourceBuilder<T>> configurator)
Parameters:configuratorAction<WebApiDataSourceBuilder<T>>

The action that configures the WebAPI data binding settings.

Returns:

DataSourceWidgetBuilder<T>

Example:
C#
@(Html.Kendo().DataSource&lt;ProductViewModel&gt;()
.Name("myDataSource")
.WebApi(dataSource =&gt; dataSource
.PageSize(10)
.Read(read =&gt; read.Action("Get", "Home"))
)
)
In this article
DefinitionConstructorsDataSourceWidgetBuilder(DataSourceWidget<T>)FieldsurlGeneratorMethodsAjax(Action<AjaxDataSourceBuilder<T>>)Custom(Action<CustomDataSourceBuilder<T>>)Gantt(Action<GanttDataSourceBuilder<T>>)GanttDependency(Action<GanttDependenciesDataSourceBuilder<T>>)Hierarchical(Action<HierarchicalDataSourceBuilder<T>>)Pivot(Action<PivotDataSourceBuilder<T>>)Scheduler(Action<SchedulerAjaxDataSourceBuilder<T>>)SignalR(Action<SignalRDataSourceBuilder<T>>)TreeList(Action<TreeListAjaxDataSourceBuilder<T>>)WebApi(Action<WebApiDataSourceBuilder<T>>)
Not finding the help you need?
Contact Support