Class TreeGridAdvancedFilterControl

Represents a control that provides advanced filter options to filter the data.

Inheritance

System.Object

TreeGridAdvancedFilterControl

Implements

System.IDisposable

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.UI.Xaml.TreeGrid.Filtering

Assembly: Syncfusion.Grid.WinUI.dll

Syntax

public class TreeGridAdvancedFilterControl : ContentControl, IDisposable, INotifyPropertyChanged

Constructors

TreeGridAdvancedFilterControl()

Initializes a new instance of the TreeGridAdvancedFilterControl class.

Declaration

public TreeGridAdvancedFilterControl()

Fields

CanGenerateUniqueItemsProperty

Identifies the CanGenerateUniqueItems dependency property.

Declaration

public static readonly DependencyProperty CanGenerateUniqueItemsProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the CanGenerateUniqueItems dependency property.

FilterTypeComboItemsProperty

Identifies the FilterTypeComboItems dependency property.

Declaration

public static readonly DependencyProperty FilterTypeComboItemsProperty

Field Value

Type
Microsoft.UI.Xaml.DependencyProperty

Remarks

The identifier for the FilterTypeComboItems dependency property.

Properties

CanGenerateUniqueItems

Gets or sets a value indicating whether all the unique items in the column are loaded or not.

Declaration

public bool CanGenerateUniqueItems { get; set; }

Property Value

Type	Description
System.Boolean	true if ComboBox is loaded in advanced filter; false if TextBox is loaded that allows you to manually enter text for filtering. The default value is true.

ComboItemsSource

Gets or sets the collection of FilterElement.

Declaration

public ObservableCollection<FilterElement> ComboItemsSource { get; set; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<FilterElement>	The collection of FilterElement.

DateFilterValue1

Gets or sets a value that indicates the DateFilterValue1 in TreeGridAdvancedFilterControl.

Declaration

public object DateFilterValue1 { get; set; }

Property Value

Type	Description
System.Object	An object that specifies the selected DateFilterValue of the corresponding DateFilter.

Remarks

Which is used to update the selected DateFilterValue to the first DatePicker in the TreeGridAdvancedFilterControl.

DateFilterValue2

Gets or sets a value that indicates the DateFilterValue2 in TreeGridAdvancedFilterControl.

Declaration

public object DateFilterValue2 { get; set; }

Property Value

Type	Description
System.Object	An object that specifies the selected DateFilterValue of the corresponding DateFilter.

Remarks

Which is used to update the selected DateFilterValue to the second DatePicker in the TreeGridAdvancedFilterControl.

DatePickerVisibility

Gets or sets DatePicker visibility for DateFilters in TreeGridAdvancedFilterControl.

Declaration

public bool DatePickerVisibility { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true.

Error

Gets an error message indicating what is wrong with this object.

Declaration

public string Error { get; }

Property Value

Type
System.String

ErrorMessage1

Gets or sets the ErrorMessage to the first editable filter elements (ie.TextBox or ComboBox) in the TreeGridAdvancedFilterControl.

Declaration

public string ErrorMessage1 { get; set; }

Property Value

Type
System.String

Remarks

When we entered the wrong values in the editable filter elements of TreeGridAdvancedFilterControl then the error message will be shown in the Microsoft.UI.Xaml.Controls.ToolTip

ErrorMessage2

Gets or sets the ErrorMessage to the second editable filter elements (ie.TextBox or ComboBox) in the TreeGridAdvancedFilterControl.

Declaration

public string ErrorMessage2 { get; set; }

Property Value

Type
System.String

Remarks

When we entered the wrong values in the editable filter elements of TreeGridAdvancedFilterControl then the error message will be shown in the Microsoft.UI.Xaml.Controls.ToolTip

FilterSelectedItem1

Gets or sets the selectedItem to the first filter comboBox in TreeGridAdvancedFilterControl.

Declaration

public object FilterSelectedItem1 { get; set; }

Property Value

Type
System.Object

Remarks

Which is used to select the existing filter data in the first Combobox while opening the TreeGridAdvancedFilterControl.

FilterSelectedItem2

Gets or sets the selectedItem to the second filter comboBox in TreeGridAdvancedFilterControl.

Declaration

public object FilterSelectedItem2 { get; set; }

Property Value

Type
System.Object

Remarks

Which is used to select the existing filter data in the second Combobox while opening the TreeGridAdvancedFilterControl.

FilterType1

Gets or sets a value that indicates the FilterType1 in TreeGridAdvancedFilterControl.

Declaration

public string FilterType1 { get; set; }

Property Value

Type	Description
System.String	A string that specifies the selected filter type of the corresponding AdvancedFilterType.

Remarks

Which is used to update the selected FilterType to the first MenuComboBox in the TreeGridAdvancedFilterControl.

FilterType2

Gets or sets a value that indicates the FilterType2 in TreeGridAdvancedFilterControl.

Declaration

public string FilterType2 { get; set; }

Property Value

Type	Description
System.String	A string that specifies the selected filter type of the corresponding AdvancedFilterType.

Remarks

Which is used to update the selected FilterType to the second MenuComboBox in the TreeGridAdvancedFilterControl.

FilterTypeComboItems

Gets or sets the collections of FilterType to the first and second MenuComboBox in TreeGridAdvancedFilterControl.

Declaration

public object FilterTypeComboItems { get; set; }

Property Value

Type
System.Object

Remarks

And the FilterType collection is varied depending upon the .

FilterValue1

Gets or sets the text for the first editble filter UIElement.This UIElement will be a TextBox or ComboBox.

Declaration

public object FilterValue1 { get; set; }

Property Value

Type
System.Object

Remarks

The value of this property is validated by using the type of the column property. If we entered any wrong value in the UIElement then the ErrorMessage1 will be shown in the Microsoft.UI.Xaml.Controls.ToolTip.

FilterValue2

Gets or sets the text of second editable filter UIElement.This UIElement will be a TextBox or ComboBox.

Declaration

public object FilterValue2 { get; set; }

Property Value

Type
System.Object

Remarks

The value of this property is validated by using the type of the column property. If we entered any wrong value in the UIElement then the ErrorMessage2 will be shown in the Microsoft.UI.Xaml.Controls.ToolTip.

IsCaseSensitive1

Gets or sets a value that indicates whether the case sensitive filter is enabled for the first CasingButton.

Declaration

public bool IsCaseSensitive1 { get; set; }

Property Value

Type	Description
System.Boolean	true if CaseSensitive button is clicked; otherwise,false. The default value is false.

IsCaseSensitive2

Gets or sets a value that indicates whether the case sensitive filter is enabled for the second CasingButton.

Declaration

public bool IsCaseSensitive2 { get; set; }

Property Value

Type	Description
System.Boolean	true if CaseSensitive button is clicked; otherwise,false. The default value is false.

IsORChecked

Gets or sets a value indicating whether OR radio button is checked or not.

Declaration

public Nullable<bool> IsORChecked { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	true if OR radio button is checked; otherwise,false. The default value is true.

Item[String]

Gets the Error message for the specified column.

Declaration

public string this[string columnName] { get; }

Parameters

Type	Name	Description
System.String	columnName	The specified column.

Property Value

Type	Description
System.String	The Error message for the specified column.

Methods

Dispose()

Disposes all the resources used by the TreeGridAdvancedFilterControl class.

Declaration

public void Dispose()

Dispose(Boolean)

Disposes all the resources used by the TreeGridAdvancedFilterControl 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.

GetFirstFilterValue()

Get the first filter value based on the first edit element ie.(TextBox or ComboBox) value and first date picker value and first MenuComboBox selectedItem value in TreeGridAdvancedFilterControl.

Declaration

public virtual object GetFirstFilterValue()

Returns

Type	Description
System.Object	Return the Filter value.

Remarks

Which mainly is used to update the ErrorMessage1 and ErrorMessage2 if the returned filter value is wrong or invalid.

GetSecondFilterValue()

Get the second filter value based on the second edit element ie.(TextBox or ComboBox) value and second date picker value and second MenuComboBox selectedItem value in TreeGridAdvancedFilterControl.

Declaration

public virtual object GetSecondFilterValue()

Returns

Type	Description
System.Object	Return the Filter value.

Remarks

Which mainly is used to update the ErrorMessage1 and ErrorMessage2 if the returned filter value is wrong or invalid.

OnApplyTemplate()

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

Declaration

protected override void OnApplyTemplate()

Events

PropertyChanged

Occurs when the property value is changed.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable

System.ComponentModel.INotifyPropertyChanged