Class
SpreadValuesFilter

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

Definition

Namespace:Telerik.Documents.SpreadsheetStreaming

Assembly:Telerik.Documents.SpreadsheetStreaming.dll

Syntax:

cs-api-definition
public class SpreadValuesFilter : ISpreadFilter

Inheritance: objectSpreadValuesFilter

Implements: ISpreadFilter

Constructors

SpreadValuesFilter(IEnumerable<SpreadDateGroupItem>)

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

Declaration

cs-api-definition
public SpreadValuesFilter(IEnumerable<SpreadDateGroupItem> dateItems)

Parameters

dateItems

IEnumerable<SpreadDateGroupItem>

The date group items to match.

SpreadValuesFilter(IEnumerable<string>)

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

Declaration

cs-api-definition
public SpreadValuesFilter(IEnumerable<string> stringValues)

Parameters

stringValues

IEnumerable<string>

The string values to match.

SpreadValuesFilter(IEnumerable<string>, IEnumerable<SpreadDateGroupItem>, bool)

Initializes a new instance of the SpreadValuesFilter class.

Declaration

cs-api-definition
public SpreadValuesFilter(IEnumerable<string> stringValues, IEnumerable<SpreadDateGroupItem> dateItems, bool blank)

Parameters

stringValues

IEnumerable<string>

The string values to match. Can be null.

dateItems

IEnumerable<SpreadDateGroupItem>

The date group items to match. Can be null.

blank

bool

Whether to include blank cells.

Exceptions

ArgumentException

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

SpreadValuesFilter(IEnumerable<string>, bool)

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

Declaration

cs-api-definition
public SpreadValuesFilter(IEnumerable<string> stringValues, bool blank)

Parameters

stringValues

IEnumerable<string>

The string values to match.

blank

bool

Whether to include blank cells.

Properties

Blank

Gets a value indicating whether to include blank cells.

Declaration

cs-api-definition
public bool Blank { get; }

Property Value

bool

DateItems

Gets the date group items to match.

Declaration

cs-api-definition
public IList<SpreadDateGroupItem> DateItems { get; }

Property Value

IList<SpreadDateGroupItem>

StringValues

Gets the string values to match.

Declaration

cs-api-definition
public IList<string> StringValues { get; }

Property Value

IList<string>