GemBox.Spreadsheet
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    CustomFilter Class

    Namespace:
    GemBox.Spreadsheet
    Assembly:
    GemBox.Spreadsheet.dll

    Represents a filter that specifies one or two conditions (operators and values) and whether the two conditions are joined by 'and' or 'or'.

    • C#
    • VB.NET
    public sealed class CustomFilter : Filter
    Public NotInheritable Class CustomFilter
        Inherits Filter
    Inheritance:
    System.Object
    Filter
    CustomFilter

    Properties

    And

    Gets or sets the value indicating whether the two conditions have an "and" relationship. true indicates "and", false indicates "or" and null indicates that second condition won't be applied.

    • C#
    • VB.NET
    public bool? And { get; set; }
    Public Property And As Boolean?
    Property Value
    System.Nullable<System.Boolean>

    The value indicating whether the two conditions have an "and" relationship.

    FilterType

    Gets the Custom value.

    • C#
    • VB.NET
    public override FilterType FilterType { get; }
    Public Overrides ReadOnly Property FilterType As FilterType
    Property Value
    FilterType

    The Custom value.

    Overrides
    Filter.FilterType

    Operator

    Gets or sets the operator used by the (first) filter condition.

    • C#
    • VB.NET
    public FilterOperator Operator { get; set; }
    Public Property Operator As FilterOperator
    Property Value
    FilterOperator

    The operator used by the (first) filter condition.

    Operator2

    Gets or sets the operator used by the second filter condition.

    • C#
    • VB.NET
    public FilterOperator Operator2 { get; set; }
    Public Property Operator2 As FilterOperator
    Property Value
    FilterOperator

    The operator used by the second filter condition.

    Value

    Gets or sets the value used by the (first) filter condition.

    The value's type must be supported in Value (null and types supported in SupportsType(Type)).

    • C#
    • VB.NET
    public object Value { get; set; }
    Public Property Value As Object
    Property Value
    System.Object

    The value used by the (first) filter condition.

    Exceptions
    System.NotSupportedException

    Value's type is not supported.

    Value2

    Gets or sets the value used by the second filter condition.

    The value's type must be supported in Value (null and types supported in SupportsType(Type)).

    • C#
    • VB.NET
    public object Value2 { get; set; }
    Public Property Value2 As Object
    Property Value
    System.Object

    The value used by the second filter condition.

    Exceptions
    System.NotSupportedException

    Value's type is not supported.

    Methods

    ToString()

    Returns a System.String that represents this CustomFilter instance.

    • C#
    • VB.NET
    public override string ToString()
    Public Overrides Function ToString As String
    Returns
    System.String

    A System.String that represents this CustomFilter instance.

    Overrides
    Filter.ToString()
    Remarks

    This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

    Examples

    Excel AutoFiltering example
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.