PivotFilter Interface

Definition

Namespace:

Microsoft.Office.Interop.Excel

Assembly:

Microsoft.Office.Interop.Excel.dll

A PivotFilter is applied to a PivotField object.

public interface class PivotFilter

[System.Runtime.InteropServices.Guid("00024483-0000-0000-C000-000000000046")]
[System.Runtime.InteropServices.InterfaceType(2)]
public interface PivotFilter

Public Interface PivotFilter

Attributes

GuidAttribute InterfaceTypeAttribute

Remarks

Developers have the option of naming filters for reference since the index is not reliable. The DataField property specifies the PivotField to base a value filter on.

Properties

Active	Returns whether the specified PivotFilter is active. Read-only.
Application	When used without an object qualifier, this property returns the Microsoft Office Excel _Application. When used with an object qualifier, this property returns the creator of the specified object. Read-only.
Creator	Returns a 32-bit Integer that indicates the application in which this object was created. Read-only.
DataCubeField	This property is applicable only to OLAP PivotTables and provides the Value field (PivotField in the Values area) being filtered by for a value filter. Read/write.
DataField	This property is applicable only to non-OLAP PivotTables and provides the Value field (PivotField in the Values area) being filtered by for a value filter. Read/write.
Description	Provides an optional description for the PivotFilter object. Read-only.
FilterType	Specifies the type of filter to be applied. Read-only.
IsMemberPropertyFilter	Specifies whether the label filter is based on the PivotItem captions of a member property of the field or on the PivotItem captions of the PivotField itself. Read-only.
MemberPropertyField	This property specifies the member property PivotField on which the label filter is based. Read/write.
Name	This property provides the option of naming filters for reference. You cannot rely on the index value for accurate reference because this value can change.
Order	Specifies the evaluation order of the filter among all Value filters applied to the entire PivotTable. Read/write
Parent	Returns the parent for the specified PivotFilter. Read-only.
PivotField	Specifies the PivotField to which the filter is applied. Read-only.
Value1	This property is a user-supplied parameter to define a filter for a PivotField. Read/write.
Value2	This property is a user-supplied parameter to define a filter for a PivotField. Read/write.
WholeDayFilter	Sets or gets the filtering semantics for date filters. Boolean (bool in C#). Read/Write

Methods

Delete()

Deletes the filter and removes it from the filter collections of the PivotField and the PivotTable.