Class TreeGridCheckBoxFilterControl

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

Inheritance
System.Object
TreeGridCheckBoxFilterControl
Implements
System.IDisposable
Namespace: Syncfusion.UI.Xaml.TreeGrid.Filtering
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class TreeGridCheckBoxFilterControl : ContentControl, IDisposable

Constructors

TreeGridCheckBoxFilterControl()

Initializes a new instance of the TreeGridCheckBoxFilterControl class.

Declaration
public TreeGridCheckBoxFilterControl()

Fields

HasItemsSourceProperty

Identifies the HasItemsSource dependency property.

Declaration
public static readonly DependencyProperty HasItemsSourceProperty
Field Value
Type Description
System.Windows.DependencyProperty
Remarks

The identifier for the HasItemsSource dependency property.

IsItemSourceLoadedProperty

Identifies the IsItemSourceLoaded dependency property.

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

The identifier for the IsItemSourceLoaded dependency property.

ItemsSourceProperty

Identifies the ItemsSource dependency property.

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

The identifier for the ItemsSource dependency property.

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateProperty
Field Value
Type Description
System.Windows.DependencyProperty

SearchOptionVisibilityProperty

Identifies the SearchOptionVisibility dependency property.

Declaration
public static readonly DependencyProperty SearchOptionVisibilityProperty
Field Value
Type Description
System.Windows.DependencyProperty
Remarks

The identifier for the SearchOptionVisibility dependency property.

SearchTextBlockVisibilityProperty

Identifies the SearchTextBlockVisibility dependency property.

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

The identifier for the SearchTextBlockVisibility dependency property.

Properties

HasItemsSource

Gets or sets a value that indicates whether TreeGridCheckBoxFilterControl has ItemsSource.

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

True if TreeGridCheckBoxFilterControl has ItemsSource; otherwise,false. The default value is false.

IsItemSourceLoaded

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

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

True if ItemsSource is loaded in TreeGridCheckBoxFilterControl; otherwise,false. The default value is false.

ItemsSource

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

Declaration
public object ItemsSource { get; set; }
Property Value
Type Description
System.Object

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

ItemTemplate

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

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Type Description
System.Windows.DataTemplate

The template that is used to specify the visualization of the data objects.The default value is null.
Remarks

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

SearchOptionVisibility

Gets or sets a value indicating the visibility of the search option.

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

SearchTextBlockVisibility

Gets or sets a value indicating the visibility of the search watermark in the search textbox.

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

Methods

Dispose()

Disposes all the resources used by the TreeGridCheckBoxFilterControl class.

Declaration
public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeGridCheckBoxFilterControl 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 when a new template is applied.

Declaration
public override void OnApplyTemplate()

OnPreviewKeyDown(KeyEventArgs)

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

Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.

Events

PropertyChanged

Occurs when the property value is changed.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable