CustomHierarchicalDataSourceBuilder

Defines the fluent interface for configuring a custom hierarchical DataSource.

Methods

Transport(System.Action)

Configures the transport of the DataSource

Parameters

configurator - System.Action<ReadOnlyCustomDataSourceTransportBuilder>

Schema(System.Action)

Configures Schema properties

Parameters

configurator - System.Action<CustomHierarchicalDataSourceSchemaBuilder>

Filter(System.Action)

Configures the initial filter.

Parameters

configurator - System.Action<ReadOnlyCustomDataSourceFilterDescriptorFactory>

Sort(System.Action)

Configures the initial sort.

Parameters

configurator - System.Action<ReadOnlyCustomDataSourceSortDescriptorFactory>

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)
            )

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")
            )

Page(System.Int32)

Sets the page of the DataSource.

Parameters

page - System.Int32

Example

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

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

Example

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