PivotFilter Members (Excel)

A PivotFilter is applied to a PivotField object.

Methods

Name

Description

Delete

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

Properties

Name

Description

Active

Returns whether the specified PivotFilter is active. Read-only Boolean.

Application

When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents 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 Long.

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 CubeField.

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 PivotField.

Description

Provides an optional description for the PivotFilter object. Read-only String.

FilterType

Specifies the type of filter to be applied. Read-only xlPivotFilterType.

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 Boolean.

MemberPropertyField

This property specifies the member property PivotField on which the label filter is based. Read/write PivotField.

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 Integer.

Parent

Returns the parent object for the specified PivotFilter object. 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 Variant.

Value2

This property is a user-supplied parameter to define a filter for a PivotField. Read/write Variant.