ValuesFilter Class

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

Represents a filter that filters by a list of values.

public sealed class ValuesFilter : Filter
Public NotInheritable Class ValuesFilter
    Inherits Filter
Inheritance:
System.Object
ValuesFilter

Properties

FilterType

Gets the Values value.

public override FilterType FilterType { get; }
Public Overrides ReadOnly Property FilterType As FilterType
Property Value
FilterType

The Values value.

Overrides

Values

Gets the list of values to filter by.

The list can contain null, System.String and DateTimeGroup values.

public IList Values { get; }
Public ReadOnly Property Values As IList
Property Value
System.Collections.IList

The list of values to filter by.

Methods

SetValues(IEnumerable)

Sets the list of values to filter by.

The list can contain null, System.String and DateTimeGroup values.

public void SetValues(IEnumerable items)
Public Sub SetValues(items As IEnumerable)
Parameters
items
System.Collections.IEnumerable

The list of values to filter by.

Exceptions
System.NotSupportedException

items contains an item which is not null, System.String or DateTimeGroup.

SetValues(Object[])

Sets the list of values to filter by.

The list can contain null, System.String and DateTimeGroup values.

public void SetValues(params object[] items)
Public Sub SetValues(ParamArray items As Object())
Parameters
items
System.Object[]

The list of values to filter by.

Exceptions
System.NotSupportedException

items contains an item which is not null, System.String or DateTimeGroup.

ToString()

Returns a System.String that represents this ValuesFilter instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this ValuesFilter instance.

Overrides
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