Hide

YetaWF.Core Package Documentation

Display
Print

YetaWF.Core.DataProvider.DataProviderSortInfo.UpdateAlternateSortColumn Method

Used to change a sort column when another column is used to sort rather than the displayed property. This method translates the displayed property name to the actual sort column name.

Class: YetaWF.Core.DataProvider.DataProviderSortInfo
Namespace: YetaWF.Core.DataProvider
Assembly: YetaWF.Core

Syntax

public static void UpdateAlternateSortColumn(
    List<DataProviderSortInfo>? sort,
    List<DataProviderFilterInfo>? filters,
    string displayProperty,
    string realColumn );

Parameters

sort

A collection describing the sort order.

filters

A collection describing the filtering criteria.

displayProperty

The name of the property as displayed by the grid.

realColumn

The name of the property that should be used by the data provider for sort/filter purposes.

Remarks

This is typically used when one property is displayed in a grid, but another property should be used for sort purposes. It is called before retrieving data from a data provider to translate the grid's column(s) to the column(s) used to sort/filter by the data provider.

The parameter sort only supports 1 sort field.

See Also YetaWF.Core.DataProvider.DataProviderSortInfo ClassYetaWF.Core Overview