WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SpreadsheetFilterControl - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SpreadsheetFilterControl

    Represents a control that contains filter popup to filter the data in SpreadsheetFilterControl

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

    Constructors

    SpreadsheetFilterControl(SfSpreadsheet, Popup)

    Set the Default Style for the spreadsheetFilterControl and initializes a new instance of the SpreadsheetFilterControl class.

    Declaration
    public SpreadsheetFilterControl(SfSpreadsheet spreadsheet, Popup filterPopup)
    Parameters
    Type Name Description
    SfSpreadsheet spreadsheet

    Spreadsheet instance

    System.Windows.Controls.Primitives.Popup filterPopup

    FilterPopup instance

    Fields

    FilterColumnTypeProperty

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

    FilterPopupHeightProperty

    DependencyProperty registration for FilterPopupHeight. Set the initial spreadsheetFilterPopup height.

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

    FilterPopupWidthProperty

    DependencyProperty registration for FilterPopupWidth which set the intial popup width for the spreadsheetFilterControl.

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

    IsAdvancedFilterVisibleProperty

    Identifies the Syncfusion.UI.Xaml.Spreadsheet.SpreadsheetFilterControl.IsAdvancedFilterVisible dependency property.

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

    Properties

    FilterColumnType

    Gets or sets a value indicating FilterColumnType in SpreadsheetFilterControl.That is TextFilter or NumberFilter or DateFilter.

    Declaration
    public string FilterColumnType { get; set; }
    Property Value
    Type Description
    System.String

    A string that specifies FilterColumnType of SpreadsheetFilterControl The default value is TextFilters.

    FilterPopupHeight

    Gets or sets height for Filter popup height.

    Declaration
    public double FilterPopupHeight { get; set; }
    Property Value
    Type Description
    System.Double

    Filter popup height

    FilterPopupWidth

    Gets or sets width for filter popup.

    Declaration
    public double FilterPopupWidth { get; set; }
    Property Value
    Type Description
    System.Double

    Filter popup width

    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.

    Methods

    Dispose()

    Disposes all the resources used by the SpreadsheetFilterControl class.

    Declaration
    public void Dispose()

    Dispose(Boolean)

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

    Declaration
    public override void OnApplyTemplate()

    OnPreviewKeyDown(KeyEventArgs)

    Handled when key press on the Keyboard. That is when press the left and Up key, focus is moved to previous element in the spreadsheetFilterControl. when press right, Tab and down arrow key, focus is moved to the next element in the spreadsheetFilterControl. When press the escape key filter popup should be closed.

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

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved