Class PivotFilterCollection

Class PivotFilterCollection

Namespace: Aspose.Cells.Pivot
Assembly: Aspose.Cells.dll (25.2.0)

Represents a collection of all the PivotFilter objects

public class PivotFilterCollection : CollectionBase<pivotfilter>, IList<pivotfilter>, ICollection<pivotfilter>, IEnumerable<pivotfilter>, ICollection, IEnumerable

Inheritance

objectCollectionBase<pivotfilter>PivotFilterCollection

Implements

IList<pivotfilter>, ICollection<pivotfilter>, IEnumerable<pivotfilter>, ICollection, IEnumerable

Inherited Members

CollectionBase<pivotfilter>.BinarySearch(PivotFilter), CollectionBase<pivotfilter>.BinarySearch(PivotFilter, IComparer<pivotfilter>), CollectionBase<pivotfilter>.BinarySearch(int, int, PivotFilter, IComparer<pivotfilter>), CollectionBase<pivotfilter>.Contains(PivotFilter), CollectionBase<pivotfilter>.CopyTo(PivotFilter[]), CollectionBase<pivotfilter>.CopyTo(PivotFilter[], int), CollectionBase<pivotfilter>.CopyTo(int, PivotFilter[], int, int), CollectionBase<pivotfilter>.Exists(Predicate<pivotfilter>), CollectionBase<pivotfilter>.Find(Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindAll(Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindIndex(Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindIndex(int, Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindIndex(int, int, Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindLast(Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindLastIndex(Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindLastIndex(int, Predicate<pivotfilter>), CollectionBase<pivotfilter>.FindLastIndex(int, int, Predicate<pivotfilter>), CollectionBase<pivotfilter>.IndexOf(PivotFilter), CollectionBase<pivotfilter>.IndexOf(PivotFilter, int), CollectionBase<pivotfilter>.IndexOf(PivotFilter, int, int), CollectionBase<pivotfilter>.LastIndexOf(PivotFilter), CollectionBase<pivotfilter>.LastIndexOf(PivotFilter, int), CollectionBase<pivotfilter>.LastIndexOf(PivotFilter, int, int), CollectionBase<pivotfilter>.GetEnumerator(), CollectionBase<pivotfilter>.Clear(), CollectionBase<pivotfilter>.RemoveAt(int), CollectionBase<pivotfilter>.OnClearComplete(), CollectionBase<pivotfilter>.OnClear(), CollectionBase<pivotfilter>.Capacity, CollectionBase<pivotfilter>.Count, CollectionBase<pivotfilter>.InnerList, CollectionBase<pivotfilter>.this[int], object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Properties

this[int]

Gets the pivotfilter object at the specific index.

public PivotFilter this[int index] { get; }

Property Value

PivotFilter

Methods

AddDateFilter(int, PivotFilterType, DateTime, DateTime)

Filters by date setting of row or column pivot field.

public PivotFilter AddDateFilter(int baseFieldIndex, PivotFilterType type, DateTime dateTime1, DateTime dateTime2)

Parameters

baseFieldIndex int

The index of field in the source.

type PivotFilterType

The type of filtering data.

dateTime1 DateTime

The date label of filter condition

dateTime2 DateTime

The upper-bound date label of between filter condition

Returns

PivotFilter

AddLabelFilter(int, PivotFilterType, string, string)

Filters by captions of row or column pivot field.

public PivotFilter AddLabelFilter(int baseFieldIndex, PivotFilterType type, string label1, string label2)

Parameters

baseFieldIndex int

The index of field in the source.

type PivotFilterType

The type of filtering data.

label1 string

The label of filter condition

label2 string

The upper-bound label of between filter condition

Returns

PivotFilter

AddTop10Filter(int, int, PivotFilterType, bool, int)

Filters by values of data pivot field.

public PivotFilter AddTop10Filter(int baseFieldIndex, int valueFieldIndex, PivotFilterType type, bool isTop, int itemCount)

Parameters

baseFieldIndex int

The index of field in the source.

valueFieldIndex int

The index of data field in the data region.

type PivotFilterType

The type of filtering data. Only can be Count,Sum and Percent.

isTop bool

Indicates whether filter from top or bottom

itemCount int

The item count

Returns

PivotFilter

AddValueFilter(int, int, PivotFilterType, double, double)

Filters by values of data pivot field.

public PivotFilter AddValueFilter(int baseFieldIndex, int valueFieldIndex, PivotFilterType type, double value1, double value2)

Parameters

baseFieldIndex int

The index of field in the source.

valueFieldIndex int

The index of value field in the value region.

type PivotFilterType

The type of filtering data.

value1 double

The value of filter condition

value2 double

The upper-bound value of between filter condition

Returns

PivotFilter

ClearFilter(int)

Clear PivotFilter from the specific PivotField

public void ClearFilter(int fieldIndex)

Parameters

fieldIndex int

the PivotField index </pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter></pivotfilter>