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

Provides the base functionality for configuring SignalR DataSource operations.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

TSignalRDataSourceBuilder

The type of the SignalR DataSource builder.

Syntax:

C#
public abstract class SignalRDataSourceBuilderBase<TSignalRDataSourceBuilder> where TSignalRDataSourceBuilder : SignalRDataSourceBuilderBase<TSignalRDataSourceBuilder>

Inheritance: objectSignalRDataSourceBuilderBase<TSignalRDataSourceBuilder>

Derived Classes: SignalRDataSourceBuilder<TModel>SignalRHierarchicalDataSourceBuilder

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

Constructors

C#
public SignalRDataSourceBuilderBase(DataSource dataSource)
Parameters:dataSourceDataSource

Fields

C#
protected readonly DataSource dataSource

Methods

Configures whether diacritic filtering should be used.

C#
public TSignalRDataSourceBuilder AccentFoldingFiltering(string culture)
Parameters:culturestring

The used culture.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.AccentFoldingFiltering("de-DE")
))

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

C#
public virtual TSignalRDataSourceBuilder AutoSync(bool enabled)
Parameters:enabledbool

If true changes will be automatically synced, otherwise false.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.AutoSync(true)
))

Determines if modifications will be sent to the server in batches or as individually requests.

C#
public virtual TSignalRDataSourceBuilder Batch(bool enabled)
Parameters:enabledbool

If true changes will be batched, otherwise false.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.Batch(true)
))

Configures the client-side events

C#
public TSignalRDataSourceBuilder Events(Action<DataSourceEventBuilder> configurator)
Parameters:configuratorAction<DataSourceEventBuilder>

The events configuration.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.Events(e=&gt;e.RequestEnd("onRequestEnd"))
))

Sets the page of the DataSource.

C#
public TSignalRDataSourceBuilder Page(int page)
Parameters:pageint

The current page.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.Page(20)
))

Sets the number of records displayed on a single page.

C#
public TSignalRDataSourceBuilder PageSize(int pageSize)
Parameters:pageSizeint

The count of records on a page.

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.PageSize(20)
))

Enables or disables server aggregates. If enabled the data source will expect the aggregates to be calculated server-side.

C#
public TSignalRDataSourceBuilder ServerAggregates(bool enabled)
Parameters:enabledbool

True to enable server aggregates; otherwise false (the default).

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.ServerAggregates(true)
))

Enables or disables server filtering mode. If enabled the data source will make a request during filtering.

C#
public TSignalRDataSourceBuilder ServerFiltering(bool enabled)
Parameters:enabledbool

True to enable server filtering; otherwise false (the default).

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.ServerFiltering(true)
))

Enables or disables server grouping mode. If enabled the data source will make a request during grouping.

C#
public TSignalRDataSourceBuilder ServerGrouping(bool enabled)
Parameters:enabledbool

True to enable server grouping; otherwise false (the default).

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.ServerGrouping(true)
))

Enables or disables server paging mode. If enabled the data source will make a request during paging.

C#
public TSignalRDataSourceBuilder ServerPaging(bool enabled)
Parameters:enabledbool

True to enable server paging; otherwise false (the default).

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.ServerPaging(true)
))

Enables or disables server sorting mode. If enabled the data source will make a request during paging.

C#
public TSignalRDataSourceBuilder ServerSorting(bool enabled)
Parameters:enabledbool

True to enable server sorting; otherwise false (the default).

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.ServerSorting(true)
))

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

C#
public TSignalRDataSourceBuilder Total(int total)
Parameters:totalint

Number of records

Returns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.Total(20)
))

Sets the transport of the DataSource using anonymous object.

C#
public TSignalRDataSourceBuilder Transport(object settings)
Parameters:settingsobjectReturns:

TSignalRDataSourceBuilder

Example:
C#
@(Html.Kendo().DataSource&lt;OrderViewModel&gt;()
.Name("ds")
.SignalR(s=&gt;s.Transport(t=&gt; {
t.Hub("HubName");
})
.Transport(new { })
))