Class TreeGridFilterControl
Inheritance
Implements
Namespace: Syncfusion.UI.Xaml.TreeGrid.Filtering
Assembly: Syncfusion.SfGrid.WPF.dll
Syntax
public class TreeGridFilterControl : ContentControl, IDisposable, INotifyPropertyChanged
Constructors
TreeGridFilterControl()
Initializes a new instance of the
Declaration
public TreeGridFilterControl()
Fields
AdvancedFilterStyleProperty
.
Identifies the
Declaration
public static readonly DependencyProperty AdvancedFilterStyleProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
AllowBlankFiltersProperty
Identifies the
Declaration
public static readonly DependencyProperty AllowBlankFiltersProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
AscendingSortStringProperty
Identifies the AscendingSortString dependency property.
Declaration
public static readonly DependencyProperty AscendingSortStringProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
CheckBoxFilterStyleProperty
Identifies the
Declaration
public static readonly DependencyProperty CheckBoxFilterStyleProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
DescendingSortStringProperty
Identifies the DescendingSortString dependency property.
Declaration
public static readonly DependencyProperty DescendingSortStringProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
FilterColumnTypeProperty
Identifies the FilterColumnType dependency property.
Declaration
public static readonly DependencyProperty FilterColumnTypeProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
FilteredFromProperty
Identifies the
Declaration
public static readonly DependencyProperty FilteredFromProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
FilterModeProperty
Identifies the
Declaration
public static readonly DependencyProperty FilterModeProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
FilterPopupHeightProperty
Identifies the
Declaration
public static readonly DependencyProperty FilterPopupHeightProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
FilterPopupWidthProperty
DependencyProperty registration for FilterPopupWidth
Declaration
public static readonly DependencyProperty FilterPopupWidthProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
ImmediateUpdateColumnFilterProperty
Identifies the
Declaration
public static readonly DependencyProperty ImmediateUpdateColumnFilterProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
IsAdvancedFilterVisibleProperty
Identifies the
Declaration
public static readonly DependencyProperty IsAdvancedFilterVisibleProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
IsOpenProperty
Identifies the IsOpen dependency property.
Declaration
public static readonly DependencyProperty IsOpenProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
ResizingThumbVisibilityProperty
Identifies the
Declaration
public static readonly DependencyProperty ResizingThumbVisibilityProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
SortOptionVisibilityProperty
Identifies the
Declaration
public static readonly DependencyProperty SortOptionVisibilityProperty
Field Value
Type | Description |
---|---|
System.Windows.DependencyProperty |
Properties
AdvancedFilterStyle
Gets or sets the style applied to
Declaration
public Style AdvancedFilterStyle { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Style | The style which is applied to |
Remarks
To define a System.Windows.Style for a AdvancedFilter, specify a TargetType of
AdvancedFilterType
Gets or sets AdvancedFilterType for
Declaration
public AdvancedFilterType AdvancedFilterType { get; set; }
Property Value
Type | Description |
---|---|
AdvancedFilterType | One of the AdvancedFilterType enumeration that specifies which Advanced filter type needs to be loaded. The default value is TextFilter. |
AllowBlankFilters
Gets or sets a value indicating whether to allow the Blank Filters.
Declaration
public bool AllowBlankFilters { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AscendingSortString
Gets or sets the AscendingSortString.
Declaration
public string AscendingSortString { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CheckBoxFilterStyle
Gets or sets the style applied to
Declaration
public Style CheckBoxFilterStyle { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Style | The style which is applied to |
Column
Gets or sets the column.
Declaration
public TreeGridColumn Column { get; set; }
Property Value
Type | Description |
---|---|
TreeGridColumn |
DescendingSortString
Gets or sets the DescendingSortString.
Declaration
public string DescendingSortString { get; set; }
Property Value
Type | Description |
---|---|
System.String |
FilterColumnType
Gets or sets a value indicating FilterColumnType.
Declaration
public string FilterColumnType { get; set; }
Property Value
Type | Description |
---|---|
System.String |
FilteredFrom
Gets or sets a value indicating whether column is filtered from Checkbox or Advanced filter.
Declaration
public FilteredFrom FilteredFrom { get; set; }
Property Value
Type | Description |
---|---|
FilteredFrom | One of the FilteredFrom enumeration that specifies whether column is filtered from Checkbox or Advanced filter. The default mode is None. |
FilterMode
Gets or sets a value to specify the FilterMode.
Declaration
public FilterMode FilterMode { get; set; }
Property Value
Type | Description |
---|---|
FilterMode | One of the FilterMode enumeration that specifies the FilterMode in SfDataGrid The default mode is Both. |
FilterPopupHeight
Gets or sets height for Filter popup.
Declaration
public double FilterPopupHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
FilterPopupWidth
Gets or sets width for filter popup.
Declaration
public double FilterPopupWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
ImmediateUpdateColumnFilter
Gets or sets a value that indicates whether the data is automatically filtered as soon as an user selects or types value in the filter pop-up of column.
Declaration
public bool ImmediateUpdateColumnFilter { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsAdvancedFilterVisible
Gets or sets a value indicating whether AdvancedFilter should be visible or not.
Declaration
public bool IsAdvancedFilterVisible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if AdvancedFilter is visible; otherwise,false. The default value is false. |
IsOpen
Gets or sets a value that indicates whether the filter popup is opened or not.
Declaration
public bool IsOpen { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | true if the filter popup is opened; otherwise, false. The default value is false. |
ResizingThumbVisibility
Gets or sets a value indicating the ResizingThumb Visibility
Declaration
public Visibility ResizingThumbVisibility { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Visibility | One of the System.Windows.Visibility enumeration that specifies the visibility of ResizingThumb The default mode is System.Windows.Visibility.Visible. |
SortOptionVisibility
Gets or sets a value indicating the SortOptionVisibility.
Declaration
public Visibility SortOptionVisibility { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Visibility | One of the System.Windows.Visibility enumeration that specifies the visibility of SortOption. The default mode is System.Windows.Visibility.Visible. |
Methods
Dispose()
Disposes all the resources used by the
Declaration
public void Dispose()
Dispose(Boolean)
Disposes all the resources used by the
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. |
GetFormattedString(Object)
Gets the formatted text of Actual Value.
Declaration
public string GetFormattedString(object item)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item | Actual value |
Returns
Type | Description |
---|---|
System.String |
OnApplyTemplate()
Builds the visual tree for the GridFilterControl when a new template is applied.
Declaration
public override void OnApplyTemplate()
OnKeyDown(KeyEventArgs)
Called before the KeyDown event occurs.
Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.KeyEventArgs | e | System.Windows.Input.KeyEventArgs instance that contains event data. |
OnMouseLeftButtonDown(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonDown routed event is raised on this element.
Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | System.Windows.Input.MouseButtonEventArgs instance that contains event data. |
OnMouseLeftButtonUp(MouseButtonEventArgs)
Invoked when an unhandled System.Windows.UIElement.MouseLeftButtonUp routed event is raised on this element.
Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseButtonEventArgs | e | System.Windows.Input.MouseButtonEventArgs instance that contains event data. |
OnMouseMove(MouseEventArgs)
Called before the MouseMove event occurs.
Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseEventArgs | e | System.Windows.Input.MouseEventArgs instance that contains event data. |
OnMouseWheel(MouseWheelEventArgs)
Invoked when an unhandled System.Windows.UIElement.MouseWheel routed event is raised on this element.
Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Input.MouseWheelEventArgs | e | System.Windows.Input.MouseWheelEventArgs instance that contains event data. |
Events
OkButtonClick
Occurs when the OkButton is clicked
Declaration
public event EventHandler<OkButtonClikEventArgs> OkButtonClick
Event Type
Type | Description |
---|---|
System.EventHandler<OkButtonClikEventArgs> |
OnFilterElementChanged
Occurs when the FilterElement is changed.
Declaration
public event EventHandler<OnFilterElementPropertyChangedEventArgs> OnFilterElementChanged
Event Type
Type | Description |
---|---|
System.EventHandler<OnFilterElementPropertyChangedEventArgs> |
PopupOpened
Occurs when the filter Popup is opened.
Declaration
public event EventHandler<PopupOpenedEventArgs> PopupOpened
Event Type
Type | Description |
---|---|
System.EventHandler<PopupOpenedEventArgs> |
PropertyChanged
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type | Description |
---|---|
System.ComponentModel.PropertyChangedEventHandler |