Filter that displays rows whose cell values match any value in a predefined list of strings, dates, or blank entries.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Model.Filtering
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class ValuesCollectionFilter : CellValuesFilterBase, IFilter
Inheritance: objectFilterBase<ICellValue>CellValuesFilterBaseValuesCollectionFilter
Implements:
Inherited Members
Constructors
Initializes a values filter matching the specified date group items with optional blank inclusion.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<DateGroupItem> dateValues, bool blank)
Relative index of the column.
dateValuesIEnumerable<DateGroupItem>The date values.
blankboolThe value indicating whether the cells containing blank values should be shown by the filter.
Initializes a values filter matching the specified date group items, excluding blanks.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<DateGroupItem> dateValues)
Relative index of the column.
dateValuesIEnumerable<DateGroupItem>The date values.
Initializes a values filter matching the specified string values with optional blank inclusion.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, bool blank)
Relative index of the column.
stringValuesIEnumerable<string>The string values.
blankboolThe value indicating whether the cells containing blank values should be shown by the filter.
Initializes a values filter matching string values, date group items, and optionally blank cells.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, IEnumerable<DateGroupItem> dateValues, bool blank)
Relative index of the column.
stringValuesIEnumerable<string>The string values.
dateValuesIEnumerable<DateGroupItem>The date values.
blankboolThe value indicating whether the cells containing blank values should be shown by the filter.
Initializes a values filter matching both string and date group items, excluding blanks.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, IEnumerable<DateGroupItem> dateValues)
Relative index of the column.
stringValuesIEnumerable<string>The string values.
dateValuesIEnumerable<DateGroupItem>The date values.
Initializes a values filter matching the specified string values, excluding blanks.
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues)
Relative index of the column.
stringValuesIEnumerable<string>The string values.
Properties
Whether to include rows with empty or whitespace-only cell values in the filtered results.
public bool Blank { get; }
The value indicating whether the cells containing blank values should be shown by the filter.
Date group items representing hierarchical date/time criteria (year, month, day) for filtering date-formatted cells.
public IEnumerable<DateGroupItem> DateItems { get; }
The date items.
Text values to match against formatted cell content; matching is case-insensitive.
public IEnumerable<string> StringValues { get; }
The string values.
Methods
Retrieves the cell value formatted as a string or DateTime based on the cell's number format for filter comparison.
Evaluates whether the value matches any entry in the string list, date groups, or blank criteria.