Class CheckboxFilterControl

Represents a control that provides excel like filter interface with list of check box’s.

Inheritance

System.Object

CheckboxFilterControl

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.DataGrid

Assembly: Syncfusion.Grid.WinUI.dll

Syntax

public class CheckboxFilterControl : ContentControl, IDisposable

Constructors

CheckboxFilterControl()

Initializes a new instance of CheckboxFilterControl class.

Declaration

public CheckboxFilterControl()

Fields

FilteredFromProperty

Identifies the FilteredFrom dependency property.

Declaration

public static readonly DependencyProperty FilteredFromProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the FilteredFrom dependency property.

HasItemsSourceProperty

Identifies the HasItemsSource dependency property.

Declaration

public static readonly DependencyProperty HasItemsSourceProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the HasItemsSource dependency property.

IsItemSourceLoadedProperty

Identifies the IsItemSourceLoaded dependency property.

Declaration

public static readonly DependencyProperty IsItemSourceLoadedProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the IsItemSourceLoaded dependency property.

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the ItemsSource dependency property.

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration

public static readonly DependencyProperty ItemTemplateProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the ItemTemplate dependency property.

SearchOptionVisibilityProperty

Identifies the SearchOptionVisibility dependency property.

Declaration

public static readonly DependencyProperty SearchOptionVisibilityProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the SearchOptionVisibility dependency property.

SearchTextBlockVisibilityProperty

Identifies the SearchTextBlockVisibility dependency property.

Declaration

public static readonly DependencyProperty SearchTextBlockVisibilityProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the SearchTextBlockVisibility dependency property.

Properties

FilteredFrom

Gets or sets the value that holds the FilteredFrom value.

Declaration

public FilteredFrom FilteredFrom { get; set; }

Property Value

Type	Description
FilteredFrom	One of the FilteredFrom enumeration that specifies the FilteredFrom The default value of filtered from is None.

Remarks

Whenever we have changed the FilteredFrom then we should update the CheckboxFilterControl. So that only we have used the same FilteredFrom property in CheckboxFilterControl.

HasItemsSource

Gets or sets a value that indicates whether CheckboxFilterControl has ItemsSource or not.

Declaration

public bool HasItemsSource { get; set; }

Property Value

Type	Description
System.Boolean	true if the CheckboxFilterControl has ItemsSource; otherwise,false. The default value is false.

IsItemSourceLoaded

Gets or sets a value that indicates whether ItemsSource is loaded in CheckboxFilterControl.

Declaration

public bool IsItemSourceLoaded { get; set; }

Property Value

Type	Description
System.Boolean	true if the ItemsSource is loaded in CheckboxFilterControl; otherwise,false. The default value is false.

ItemsSource

Gets or sets the collection that is used to generate the content of the CheckboxFilterControl.

Declaration

public object ItemsSource { get; set; }

Property Value

Type	Description
System.Object	The collection that is used to generate the content of the CheckboxFilterControl.The default value is null.

ItemTemplate

Gets or sets the template that is used to display the items in CheckBoxFilterControl.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.DataTemplate	The template that is used to specify the visualization of the data objects.The default value is null.

Remarks

By default the CheckBoxFilterControl shows the items with List of Checkboxes.

SearchOptionVisibility

Gets or sets a value that indicating the SearchOption Visibility in CheckboxFilterControl.

Declaration

public Visibility SearchOptionVisibility { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Visibility	One of the Microsoft.UI.Xaml.Visibility enumeration that specifies the visibility of SearchOption. The default value of SearchOption Visibility is Microsoft.UI.Xaml.Visibility.Visible.

Remarks

Which is used the show or disable the SearchTextBox in CheckboxFilterControl.

Examples

<Grid.Resources>
    <Style x:Key="checkboxfilterstyleforOrderID" BasedOn="{StaticResource CheckboxFilterControlStyle}" TargetType="syncfusion:CheckboxFilterControl">
        <Setter Property="SearchOptionVisibility" Value="Collapsed" />
    </Style>
    <Style x:Key="popupstyleforOrderID" BasedOn="{StaticResource GridFilterControlStyle}" TargetType="syncfusion:GridFilterControl">
        <Setter Property="CheckboxFilterStyle" Value="{StaticResource checkboxfilterstyleforOrderID}" />
    </Style>
</Grid.Resources>
<dataGrid:SfDataGrid ItemsSource = "{Binding Orders}"  AutoGenerateColumns="False">
    <dataGrid:SfDataGrid.Columns>
        <dataGrid:GridTextColumn MappingName = "OrderID" FilterPopupStyle="{StaticResource popupstyleforOrderID}" AllowFiltering="True"/>
    </dataGrid:SfDataGrid.Columns>
</dataGrid:SfDataGrid>

SearchTextBlockVisibility

Gets or sets a value that indicates the search watermark visibility of SerachTextBox in CheckboxFilterControl.

Declaration

public Visibility SearchTextBlockVisibility { get; set; }

Property Value

Type	Description
Microsoft.UI.Xaml.Visibility	One of the Microsoft.UI.Xaml.Visibility enumeration that specifies the visibility of Search watermark. The default value of search watermark visibility is Microsoft.UI.Xaml.Visibility.Visible.

Remarks

Which is used the show or disable the watermark text of SerachTextBox in CheckboxFilterControl.

Examples

<Grid.Resources>
    <Style x:Key="checkboxfilterstyleforOrderID" BasedOn="{StaticResource CheckboxFilterControlStyle}" TargetType="syncfusion:CheckboxFilterControl">
        <Setter Property="SearchTextBlockVisibility" Value="Collapsed" />
    </Style>
    <Style x:Key="popupstyleforOrderID" BasedOn="{StaticResource GridFilterControlStyle}" TargetType="syncfusion:GridFilterControl">
        <Setter Property="CheckboxFilterStyle" Value="{StaticResource checkboxfilterstyleforOrderID}" />
    </Style>
</Grid.Resources>
<dataGrid:SfDataGrid ItemsSource = "{Binding Orders}"  AutoGenerateColumns="False">
    <dataGrid:SfDataGrid.Columns>
        <dataGrid:GridTextColumn MappingName = "OrderID" FilterPopupStyle="{StaticResource popupstyleforOrderID}" AllowFiltering="True"/>
    </dataGrid:SfDataGrid.Columns>
</dataGrid:SfDataGrid>

Methods

Dispose()

Disposes all the resources used by the CheckboxFilterControl class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the CheckboxFilterControl class.

Declaration

protected virtual void Dispose(bool isDisposing)

Parameters

Type	Name	Description
System.Boolean	isDisposing	Indicates whether the call is from Dispose method or from a finalizer.

OnApplyTemplate()

Builds the visual tree for the CheckboxFilterControl when a new template is applied.

Declaration

protected override void OnApplyTemplate()

OnPreviewKeyDown(KeyRoutedEventArgs)

Occurs when the PreviewKeyDown attached event reaches an element in its route that is derived from this class.

Declaration

protected override void OnPreviewKeyDown(KeyRoutedEventArgs e)

Parameters

Type	Name	Description
Microsoft.UI.Xaml.Input.KeyRoutedEventArgs	e	The Microsoft.UI.Xaml.Input.KeyRoutedEventArgs that contains the event data.

OnPropertyChanged(String)

Invoked when PropertyChanged event occurs.

Declaration

public void OnPropertyChanged(string propertyName)

Parameters

Type	Name	Description
System.String	propertyName	The corresponding Property.

Events

PropertyChanged

Occurs when a property value changed.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable