Class CheckboxFilterControl

Class that represents a control that provides excel like CheckBoxFilter interface for filter the data.

Inheritance
System.Object
CheckboxFilterControl
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.Spreadsheet
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public class CheckboxFilterControl : ContentControl, IDisposable

Constructors

CheckboxFilterControl()

Set the default style for the CheckBoxFilter class and initializes a new instance of the CheckboxFilterControl class.

Declaration
public CheckboxFilterControl()

Fields

IsItemSourceLoadedProperty

Identifies the Syncfusion.UI.Xaml.Grid.CheckboxFilterControl.IsItemSourceLoaded dependency property. Based on the property loading animation is visible in the checkBoxFilter control.

Declaration
public static readonly DependencyProperty IsItemSourceLoadedProperty
Field Value
Type
System.Windows.DependencyProperty

ItemsSourceProperty

Identifies the Syncfusion.UI.Xaml.Spreadsheet.CheckboxFilterControl.ItemsSource dependency property. which maintained to hold the itemsSource for the checkBoxFilter control.

Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
Type
System.Windows.DependencyProperty

SearchTextBlockVisibilityProperty

Identifies the Syncfusion.UI.Xaml.Spreadsheet.CheckboxFilterControl.SearchTextBlockVisibility dependency property.

Declaration
public static readonly DependencyProperty SearchTextBlockVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

IsItemSourceLoaded

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

Declaration
public bool IsItemSourceLoaded { get; set; }
Property Value
Type Description
System.Boolean

true if 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 List<FilterElement> ItemsSource { get; set; }
Property Value
Type Description
System.Collections.Generic.List<FilterElement>

The collection that is used to generate the content of the CheckboxFilterControl.The default value is null.

SearchTextBlockVisibility

Gets or sets a value indicating the Search watermark Visibility of the search TextBox.

Declaration
public Visibility SearchTextBlockVisibility { get; set; }
Property Value
Type Description
System.Windows.Visibility

One of the System.Windows.Visibility enumeration that specifies the visibility of Search watermark. The default mode is System.Windows.Visibility.Visible.

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
public override void OnApplyTemplate()

Implements

System.IDisposable