PivotFilter Class

Namespace:
GemBox.Spreadsheet.PivotTables
Assembly:
GemBox.Spreadsheet.dll

Represents a filter for a single pivot field.

public sealed class PivotFilter
Public NotInheritable Class PivotFilter
Inheritance:
System.Object
PivotFilter

Properties

Field

Gets the pivot field that this pivot filter applies to.

public PivotField Field { get; }
Public ReadOnly Property Field As PivotField
Property Value
PivotField

The pivot field that this pivot filter applies to.

Filter

Gets the filter settings applied to this pivot field or null if no filter settings are applied to this pivot field.

public Filter Filter { get; }
Public ReadOnly Property Filter As Filter
Property Value
Filter

The filter settings applied to this pivot field or null if no filter settings are applied to this pivot field.

MeasureField

Gets the pivot field containing summary values being filtered.

public PivotField MeasureField { get; set; }
Public Property MeasureField As PivotField
Property Value
PivotField

The pivot field containing summary values being filtered.

Methods

ClearFilter()

Clears the filter from this PivotFilter.

public void ClearFilter()
Public Sub ClearFilter

SetCustomFilter()

Sets a CustomFilter to this field.

CustomFilter filters by a one or two conditions (operators and values).

Use members of a returned CustomFilter to specify filter settings.

public CustomFilter SetCustomFilter()
Public Function SetCustomFilter As CustomFilter
Returns
CustomFilter
Remarks

If this PivotFilter already specifies a filter (Filter is not equal to null), it will be overridden.

SetDynamicFilter()

Sets a DynamicFilter to this field.

DynamicFilter filters by a dynamic criteria that can change, either with the data itself (e.g., "above average") or with the current system date (e.g., show values for "today").

Use members of a returned DynamicFilter to specify filter settings.

public DynamicFilter SetDynamicFilter()
Public Function SetDynamicFilter As DynamicFilter
Returns
DynamicFilter
Remarks

If this PivotFilter already specifies a filter (Filter is not equal to null), it will be overridden.

SetTop10Filter()

Sets a Top10Filter to this field.

Top10Filter filters by a top N (percent or number of items).

Use members of a returned Top10Filter to specify filter settings.

public Top10Filter SetTop10Filter()
Public Function SetTop10Filter As Top10Filter
Returns
Top10Filter
Remarks

If this PivotFilter already specifies a filter (Filter is not equal to null), it will be overridden.

ToString()

Returns a System.String that represents this PivotFilter instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this PivotFilter instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).