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.Grid.WinUI.dll

Syntax

public class TreeGridCheckBoxFilterControl : ContentControl, IDisposable

Constructors

TreeGridCheckBoxFilterControl()

Initializes a new instance of the TreeGridCheckBoxFilterControl class.

Declaration

public TreeGridCheckBoxFilterControl()

Fields

FilteredFromProperty

Identifies the FilteredFrom dependency property.

Declaration

public static readonly DependencyProperty FilteredFromProperty

Field Value

Type	Description
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	Description
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	Description
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	Description
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	Description
Microsoft.UI.Xaml.DependencyProperty

SearchOptionVisibilityProperty

Identifies the SearchOptionVisibility dependency property.

Declaration

public static readonly DependencyProperty SearchOptionVisibilityProperty

Field Value

Type	Description
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	Description
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 TreeGridCheckBoxFilterControl. So that only we have used the same FilteredFrom property in TreeGridCheckboxFilterControl.

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
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 TreeGridCheckBoxFilterControl shows the items with List of Checkboxes.

SearchOptionVisibility

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

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 TreeGridCheckboxFilterControl.

Examples

<Grid.Resources>
    <Style x:Key="checkboxfilterstyleforEmployeeID" BasedOn="{StaticResource CheckboxFilterControlStyle}" TargetType="treeGrid:TreeGridCheckBoxFilterControl">
        <Setter Property="SearchOptionVisibility" Value="Collapsed" />
    </Style>
    <Style x:Key="popupstyleforEmployeeID" BasedOn="{StaticResource GridFilterControlStyle}" TargetType="treeGrid:TreeGridFilterControl">
        <Setter Property="CheckboxFilterStyle" Value="{StaticResource checkboxfilterstyleforEmployeeID}" />
    </Style>
</Grid.Resources>
  <treeGrid:SfTreeGrid Name="sfTreeGrid" ChildPropertyName="ReportsTo" AutoGenerateColumns="False" ItemsSource="{Binding Employees}" ParentPropertyName="ID" SelfRelationRootValue="-1" >                   
       <treeGrid:SfTreeGrid.Columns>
        <treeGrid:TreeGridTextColumn MappingName = "EmployeeID" FilterPopupStyle="{StaticResource popupstyleforEmployeeID}" AllowFiltering="True"/>
    </treeGrid:SfTreeGrid.Columns>
</treeGrid:SfTreeGrid>

SearchTextBlockVisibility

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

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 TreeGridCheckboxFilterControl.

Examples

<Grid.Resources>
    <Style x:Key="checkboxfilterstyleforEmployeeID" BasedOn="{StaticResource CheckboxFilterControlStyle}" TargetType="treeGrid:TreeGridCheckBoxFilterControl">
        <Setter Property="SearchTextBlockVisibility" Value="Collapsed" />
    </Style>
    <Style x:Key="popupstyleforEmployeeID" BasedOn="{StaticResource GridFilterControlStyle}" TargetType="treeGrid:TreeGridFilterControl">
        <Setter Property="CheckboxFilterStyle" Value="{StaticResource checkboxfilterstyleforEmployeeID}" />
    </Style>
</Grid.Resources>
  <treeGrid:SfTreeGrid Name="sfTreeGrid" ChildPropertyName="ReportsTo" AutoGenerateColumns="False" ItemsSource="{Binding Employees}" ParentPropertyName="ID" SelfRelationRootValue="-1" >                   
       <treeGrid:SfTreeGrid.Columns>
        <treeGrid:TreeGridTextColumn MappingName = "EmployeeID" FilterPopupStyle="{StaticResource popupstyleforEmployeeID}" AllowFiltering="True"/>
    </treeGrid:SfTreeGrid.Columns>
</treeGrid:SfTreeGrid>

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 TreeGridCheckBoxFilterControl 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.

Events

PropertyChanged

Occurs when the property value is changed.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable