CustomDataSourceBuilder

Methods

Transport(System.Action)

Configures the transport of the DataSource

Parameters

configurator - System.Action<CustomDataSourceTransportBuilder>

The lambda which configures the Transport property

Example

            .DataSource(dataSource => dataSource        
                .Custom()         
                .Batch(true)
                .PageSize(20)
                .Schema(schema => schema.Model(m => m.Id(p => p.ProductID)))
                .Transport(transport =>
                {
                    transport.Read(read =>
                       read.Url("https://demos.telerik.com/kendo-ui/service/products")
                           .DataType("jsonp")
                    );
                    transport.Create(create =>
                       create.Url("https://demos.telerik.com/kendo-ui/service/products/create")
                             .DataType("jsonp")
                    );
                    transport.Update(update =>
                       update.Url("https://demos.telerik.com/kendo-ui/service/products/update")
                             .DataType("jsonp")
                    );
                    transport.Destroy(destroy =>
                       destroy.Url("https://demos.telerik.com/kendo-ui/service/products/destroy")
                              .DataType("jsonp")
                    );
                    transport.ParameterMap("parameterMap");
                })
            )

Schema(System.Action)

Configures Schema properties

Parameters

configurator - System.Action<CustomDataSourceSchemaBuilder>

The lambda which configures the Schema property

Example

            .DataSource(dataSource => dataSource        
                .Custom()         
                .Batch(true)
                .PageSize(20)
                .Schema(schema => schema.Model(m => m.Id(p => p.ProductID)))
                .Transport(transport =>
                {
                    transport.Read(read =>
                       read.Url("https://demos.telerik.com/kendo-ui/service/products")
                           .DataType("jsonp")
                    );
                    transport.Create(create =>
                       create.Url("https://demos.telerik.com/kendo-ui/service/products/create")
                             .DataType("jsonp")
                    );
                    transport.Update(update =>
                       update.Url("https://demos.telerik.com/kendo-ui/service/products/update")
                             .DataType("jsonp")
                    );
                    transport.Destroy(destroy =>
                       destroy.Url("https://demos.telerik.com/kendo-ui/service/products/destroy")
                              .DataType("jsonp")
                    );
                    transport.ParameterMap("parameterMap");
                })
            )

Sort(System.Action)

Configures the initial sorting.

Parameters

configurator - System.Action<DataSourceSortDescriptorFactory>

The lambda which configures the Sort Action

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Sort(s => s.Add("ShipName"))
            )

Group(System.Action)

Configures the initial grouping.

Parameters

configurator - System.Action<DataSourceGroupDescriptorFactory>

The lambda which configures the Group Action

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Group(s => s.Add(a =>a.ShipName))
            )

Aggregates(System.Action)

Configures the initial aggregates.

Parameters

aggregates - System.Action<DataSourceAggregateDescriptorFactory>

The Aggregates set for the Custom DataSource

Example

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

Filter(System.Action)

Configures the initial filter.

Parameters

configurator - System.Action<DataSourceFilterDescriptorFactory>

The lambda which configures the Filter Action

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Filter(f => f.Add(a => a.ShipName))
            )

Events(System.Action)

Configures the client-side events

Parameters

configurator - System.Action<DataSourceEventBuilder>

The lambda which configures the Update Action

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Events(e => e.Push("onDataSourcePush"))
            )

Total(System.Int32)

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

Parameters

total - System.Int32

Number of records

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Total(50)
            )

PageSize(System.Int32)

Sets the number of records displayed on a single page.

Parameters

pageSize - System.Int32

An integer value for the size of a Page in the Custom DataSource

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .PageSize(20)
            )

Page(System.Int32)

Sets the page of the DataSource.

Parameters

page - System.Int32

Sets the page value

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Page(3)
            )

AccentFoldingFiltering(System.String)

Configures whether diacritic filtering should be used.

Parameters

culture - System.String

The culture applied for the Action

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .AccentFoldingFiltering("bg-BG")
            )

ServerPaging(System.Boolean)

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

Parameters

enabled - System.Boolean

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

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .ServerPaging(false)
            )

ServerSorting(System.Boolean)

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

Parameters

enabled - System.Boolean

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

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .ServerSorting(false)
            )

ServerFiltering(System.Boolean)

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

Parameters

enabled - System.Boolean

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

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .ServerFiltering(false)
            )

ServerGrouping(System.Boolean)

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

Parameters

enabled - System.Boolean

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

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .ServerGrouping(false)
            )

ServerAggregates(System.Boolean)

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

Parameters

enabled - System.Boolean

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

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .ServerAggregates(false)
            )

Batch(System.Boolean)

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

Parameters

enabled - System.Boolean

If true changes will be batched, otherwise false.

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Batch(true)
            )

AutoSync(System.Boolean)

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

Parameters

enabled - System.Boolean

If true changes will be automatically synced, otherwise false.

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .AutoSync(true)
            )

Transport(System.Object)

Sets the transport of the DataSource using anonymous object.

Parameters

settings - System.Object

Type(System.String)

Sets the type of the data source.

Parameters

type - System.String

If set, the data source will use a predefined transport and/or schema.

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .Type("odata")
            )

GroupPaging(System.Boolean)

Determines if group paging is enabled.

Parameters

enabled - System.Boolean

If true, group paging is enabled.

Example

            .DataSource(dataSource => dataSource
                .Custom()
                .GroupPaging(true)
            )