Class ValuesCollectionFilter

Describes a filter which hides or shows the cells based on whether the result value of the cell can be found in a predefined list of values.

Inheritance
System.Object
FilterBase<ICellValue>
CellValuesFilterBase
ValuesCollectionFilter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Model.Filtering
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class ValuesCollectionFilter : CellValuesFilterBase, IFilter, ITranslatable, ICopyable<IFilter>

Constructors

ValuesCollectionFilter(Int32, IEnumerable<String>)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<System.String> stringValues

The string values.

ValuesCollectionFilter(Int32, IEnumerable<String>, Boolean)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, bool blank)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<System.String> stringValues

The string values.
System.Boolean blank

The value indicating whether the cells containing blank values should be shown by the filter.

ValuesCollectionFilter(Int32, IEnumerable<String>, IEnumerable<DateGroupItem>)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, IEnumerable<DateGroupItem> dateValues)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<System.String> stringValues

The string values.
System.Collections.Generic.IEnumerable<DateGroupItem> dateValues

The date values.

ValuesCollectionFilter(Int32, IEnumerable<String>, IEnumerable<DateGroupItem>, Boolean)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<string> stringValues, IEnumerable<DateGroupItem> dateValues, bool blank)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<System.String> stringValues

The string values.
System.Collections.Generic.IEnumerable<DateGroupItem> dateValues

The date values.
System.Boolean blank

The value indicating whether the cells containing blank values should be shown by the filter.

ValuesCollectionFilter(Int32, IEnumerable<DateGroupItem>)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<DateGroupItem> dateValues)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<DateGroupItem> dateValues

The date values.

ValuesCollectionFilter(Int32, IEnumerable<DateGroupItem>, Boolean)

Initializes a new instance of the ValuesCollectionFilter class.

Declaration
public ValuesCollectionFilter(int relativeColumnIndex, IEnumerable<DateGroupItem> dateValues, bool blank)
Parameters
System.Int32 relativeColumnIndex

Relative index of the column.
System.Collections.Generic.IEnumerable<DateGroupItem> dateValues

The date values.
System.Boolean blank

The value indicating whether the cells containing blank values should be shown by the filter.

Properties

Blank

Gets the value indicating whether the cells containing blank values should be shown by the filter.

Declaration
public bool Blank { get; }
Property Value
System.Boolean

The value indicating whether the cells containing blank values should be shown by the filter.

DateItems

Gets the date items of the filter.

Declaration
public IEnumerable<DateGroupItem> DateItems { get; }
Property Value
System.Collections.Generic.IEnumerable<DateGroupItem>

The date items.

StringValues

Gets the string values of the filter.

Declaration
public IEnumerable<string> StringValues { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

The string values.

Methods

Equals(Object)

Determines whether the specified System.Object is equal to the current System.Object.

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

The System.Object to compare with the current System.Object.
Returns
System.Boolean

true if the specified System.Object is equal to the current System.Object; otherwise, false.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration
public override int GetHashCode()
Returns
System.Int32

A hash code for the current System.Object.
Overrides
System.Object.GetHashCode()

GetValue(Cells, Int32, Int32)

Gets the value of the cell at the specified index. This value is used to determine whether the row will be hidden by the filter.

Declaration
public override object GetValue(Cells cells, int rowIndex, int columnIndex)
Parameters
Cells cells

The cells of the worksheet.
System.Int32 rowIndex

Index of the row.
System.Int32 columnIndex

Index of the column.
Returns
System.Object

The value of the cell.
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Filtering.FilterBase<Telerik.Windows.Documents.Spreadsheet.Model.ICellValue>.GetValue(Telerik.Windows.Documents.Spreadsheet.Model.Cells, System.Int32, System.Int32)

ShouldShowValue(Object)

Determines whether the row which contains the specified value will be shown.

Declaration
public override bool ShouldShowValue(object value)
Parameters
System.Object value

The value retrieved by the GetValue method.
Returns
System.Boolean

A value indicating whether the row which contains the specified value will be shown
Overrides
Telerik.Windows.Documents.Spreadsheet.Model.Filtering.FilterBase<Telerik.Windows.Documents.Spreadsheet.Model.ICellValue>.ShouldShowValue(System.Object)

Extension Methods