PivotFilter PivotFilter PivotFilter Interface

Definition

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

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 Active Active

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

Application Application 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 Creator Creator

Returns a 32-bit Integer that indicates the application in which this object was created. Read-only.

DataCubeField DataCubeField 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 DataField 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 Description Description

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

FilterType FilterType FilterType

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

IsMemberPropertyFilter IsMemberPropertyFilter 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 MemberPropertyField MemberPropertyField

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

Name Name 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 Order Order

Specifies the evaluation order of the filter among all Value filters applied to the entire PivotTable. Read/write

Parent Parent Parent

Returns the parent for the specified PivotFilter. Read-only.

PivotField PivotField PivotField

Specifies the PivotField to which the filter is applied. Read-only.

Value1 Value1 Value1

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

Value2 Value2 Value2

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

WholeDayFilter WholeDayFilter WholeDayFilter

Sets or gets the filtering semantics for date filters. Boolean (bool in C#). Read/Write

Methods

Delete() Delete() Delete()

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

Applies to