Interface IColumnFilterHandler

Namespace

WinUI.TableView

Assembly

WinUI.TableView.dll

Interface for handling column filtering in a TableView.

public interface IColumnFilterHandler

Properties

SelectedValues

Gets or sets the selected values for the filter per column.

IDictionary<TableViewColumn, ICollection<object?>> SelectedValues { get; }

Property Value

IDictionary<TableViewColumn, ICollection<object>>

Methods

ApplyFilter(TableViewColumn)

Applies the filter to the specified column.

void ApplyFilter(TableViewColumn column)

Parameters

column TableViewColumn

The column to which the filter is applied.

ClearFilter(TableViewColumn?)

Clears the filter from the specified column.

void ClearFilter(TableViewColumn? column)

Parameters

column TableViewColumn

The column from which the filter is cleared.

Filter(TableViewColumn, object?)

Determines whether the specified item passes the filter for the specified column.

bool Filter(TableViewColumn column, object? item)

Parameters

column TableViewColumn

The column for which the filter is applied.

item object

The item to check.

Returns

bool

True if the item passes the filter; otherwise, false.

GetFilterItems(TableViewColumn, string?)

Get the filter items for the specified column.

IList<TableViewFilterItem> GetFilterItems(TableViewColumn column, string? searchText)

Parameters

column TableViewColumn

The column for which to prepare filter items.

searchText string

The search text to filter the items.

Returns

IList<TableViewFilterItem>