Skip to content

DataFilterPanel class

Defined in

Namespace: CrissCross.Avalonia.UI.Controls Assembly: CrissCross.Avalonia.UI.dll Full name: CrissCross.Avalonia.UI.Controls.DataFilterPanel Modifiers: public

Summary

        Represents a descriptor-driven filter editor surface for grids and lists.
        

Applies to

net10.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net471

Class hierarchy
classDiagram
class DataFilterPanel
class TemplatedControl
TemplatedControl <|-- DataFilterPanel

Inherits from: TemplatedControl

Constructors

NameSummary
.ctorInitializes a new instance of the [DataFilterPanel](# class.

Properties

NameSummary
FilterStateGets or sets the shared filter panel state projected by the control.
SearchTextGets or sets the query text included when applying filters.
ResultCountGets or sets the optional result count included with the emitted query state.
SubmittedQueryStateGets or sets the latest query state emitted by the panel.
ApplyFiltersCommandGets or sets the command invoked when filters are applied.
ClearFiltersCommandGets or sets the command invoked when filters are cleared.
AddFilterCommandGets or sets the command invoked when a descriptor should add or edit a filter.
RemoveFilterCommandGets or sets the command invoked when an active filter token should be removed.
ApplyCommandGets the command that applies current filters.
ClearCommandGets the command that clears current filters.

Fields

NameSummary
static FilterStatePropertyProperty for [FilterState](#
static SearchTextPropertyProperty for [SearchText](#
static ResultCountPropertyProperty for [ResultCount](#
static SubmittedQueryStatePropertyProperty for [SubmittedQueryState](#
static ApplyFiltersCommandPropertyProperty for [ApplyFiltersCommand](#
static ClearFiltersCommandPropertyProperty for [ClearFiltersCommand](#
static AddFilterCommandPropertyProperty for [AddFilterCommand](#
static RemoveFilterCommandPropertyProperty for [RemoveFilterCommand](#

Methods

NameSummary
CreateQueryStateCreates a search query snapshot from the current filter state.
ApplyFiltersApplies the current filters and emits a query-state snapshot.
ClearFiltersClears current filters through the configured command hook.
Inherited members