New to Telerik Document Processing? Start a free 30-day trial

Represents a value-based filter that shows only rows matching specific string values, date groups, or blank cells.

StringValues, DateItems, and Blank are combined with OR logic: a row passes the filter if it matches any of the string values, any of the date items, or the blank condition (when enabled).

Blank match returns true for null cells AND for string cells whose value is the empty string.

String values are matched case-insensitively during filter evaluation. Null strings are rejected at construction time; pass an empty collection instead.

Definition

Namespace:Telerik.Documents.SpreadsheetStreaming

Assembly:Telerik.Documents.SpreadsheetStreaming.dll

Syntax:

C#
public class SpreadValuesFilter : ISpreadFilter

Inheritance: objectSpreadValuesFilter

Implements: ISpreadFilter

Constructors

Initializes a new instance of the SpreadValuesFilter class with date group items.

C#
public SpreadValuesFilter(IEnumerable<SpreadDateGroupItem> dateItems)
Parameters:dateItemsIEnumerable<SpreadDateGroupItem>

The date group items to match.

Initializes a new instance of the SpreadValuesFilter class with string values and blank option.

C#
public SpreadValuesFilter(IEnumerable<string> stringValues, bool blank)
Parameters:stringValuesIEnumerable<string>

The string values to match.

blankbool

Whether to include blank cells.

Initializes a new instance of the SpreadValuesFilter class.

C#
public SpreadValuesFilter(IEnumerable<string> stringValues, IEnumerable<SpreadDateGroupItem> dateItems, bool blank)
Parameters:stringValuesIEnumerable<string>

The string values to match. Can be null.

dateItemsIEnumerable<SpreadDateGroupItem>

The date group items to match. Can be null.

blankbool

Whether to include blank cells.

Exceptions: ArgumentException

Thrown when any element of stringValues is null, or when any element of dateItems is null.

Initializes a new instance of the SpreadValuesFilter class with string values.

C#
public SpreadValuesFilter(IEnumerable<string> stringValues)
Parameters:stringValuesIEnumerable<string>

The string values to match.

Properties

Gets a value indicating whether to include blank cells.

C#
public bool Blank { get; }

Gets the date group items to match.

C#
public IList<SpreadDateGroupItem> DateItems { get; }

Gets the string values to match.

C#
public IList<string> StringValues { get; }