PivotField Members (Excel)

Represents a field in a PivotTable report.

Name

Description

AddPageItem

Adds an additional item to a multiple item page field.

AutoShow

Displays the number of top or bottom items for a row, page, or column field in the specified PivotTable report.

AutoSort

Establishes automatic field-sorting rules for PivotTable reports.

CalculatedItems

Returns a CalculatedItems collection that represents all the calculated items in the specified PivotTable report. Read-only.

ClearAllFilters

Calling this method deletes all filters currently applied to the PivotField. This includes deleting all filters from the PivotFilters collection of the PivotField and removing any manual filtering applied to the PivotField as well. If the PivotField is in the Report Filter area, the item selected will be set to the default item.

ClearLabelFilters

This method deletes all label filters or all date filters in the PivotFilters collection of the PivotField.

ClearManualFilter

Provides an easy way to set the Visible property to True for all items of a PivotField in PivotTables, and to empty the HiddenItemsList and VisibleItemsList collections in OLAP PivotTables.

ClearValueFilters

Calling this method deletes all value filters in the PivotFilters collection of the PivotField.

Delete

Deletes the object.

DrillTo

The DrillTo method supports drilling to a specified PivotField from another PivotField.

PivotItems

Returns an object that represents either a single PivotTable item (a PivotItem object) or a collection of all the visible and hidden items (a PivotItems object) in the specified field. Read-only.

Name

Description

AllItemsVisible

Used to retrieve a Boolean value that indicates whether or not any manual filtering is applied to the PivotField. Read-only.

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 (you can use this property with an OLE Automation object to return the application of that object). Read-only.

AutoShowCount

Returns the number of top or bottom items that are automatically shown in the specified PivotTable field. Read-only Long.

AutoShowField

Returns the name of the data field used to determine the top or bottom items that are automatically shown in the specified PivotTable field. Read-only String.

AutoShowRange

Returns xlTop if the top items are shown automatically in the specified PivotTable field; returns xlBottom if the bottom items are shown. Read-only Long.

AutoShowType

Returns xlAutomatic if AutoShow is enabled for the specified PivotTable field; returns xlManual if AutoShow is disabled. Read-only Long.

AutoSortCustomSubtotal

Returns the name of the custom subtotal used to sort the specified PivotTable field automatically. Read-only.

AutoSortField

Returns the name of the data field used to sort the specified PivotTable field automatically. Read-only String.

AutoSortOrder

Returns the order used to sort the specified PivotTable field automatically. Can be one of the constants of XlSortOrder. Read-only Long.

AutoSortPivotLine

Returns the name of the PivotLine used to sort the specified PivotTable field automatically. Read-only.

BaseField

Returns or sets the base field for a custom calculation. This property is valid only for data fields. Read/write Variant.

BaseItem

Returns or sets the item in the base field for a custom calculation. Valid only for data fields. Read/write Variant.

Calculation

Returns or sets a XlPivotFieldCalculation value that represents the type of calculation performed by the specified field. This property is valid only for data fields.

Caption

Returns a String value that represents the label text for the pivot field.

ChildField

Returns a PivotField object that represents the child field for the specified field (if the field is grouped and has a child field). Read-only.

ChildItems

Returns an object that represents either a single PivotTable item (a PivotItem object) or a collection of all the items (a PivotItems object) that are group children in the specified field, or children of the specified item. Read-only.

Creator

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

CubeField

Returns the CubeField object from which the specified PivotTable field is descended. Read-only.

CurrentPage

Returns or sets the current page showing for the page field (valid only for page fields). Read/write PivotItem.

CurrentPageList

Returns or sets an array of strings corresponding to the list of items included in a multiple-item page field of a PivotTable report. Read/write Variant.

CurrentPageName

Returns or sets the currently displayed page of the specified PivotTable report. The name of the page appears in the page field. Note that this property works only if the currently displayed page already exists. Read/write String.

DatabaseSort

When set to True, manual repositioning of items in a PivotTable field is allowed. Returns True, if the field has no manually positioned items. Read/write Boolean.

DataRange

Returns a Range object as shown in the following table. Read-only.

DataType

Returns a XlPivotFieldDataType value that represents the type of data in the PivotTable field.

DisplayAsCaption

This property is used to display member properties of PivotFields as captions. Read-only.

DisplayAsTooltip

This property is used to specify whether or not a specific member property PivotField is displayed in tooltips. Read/write Boolean.

DisplayInReport

This property is used to specify whether the specified member property PivotField is displayed in the PivotTable or not. Read/write Boolean.

DragToColumn

True if the specified field can be dragged to the column position. The default value is True. Read/write Boolean.

DragToData

True if the specified field can be dragged to the data position. The default value is True. Read/write Boolean

DragToHide

True if the field can be hidden by being dragged off the PivotTable report. The default value is True. Read/write Boolean.

DragToPage

True if the field can be dragged to the page position. The default value is True. Read/write Boolean.

DragToRow

True if the field can be dragged to the row position. The default value is True. Read/write Boolean.

DrilledDown

True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible). Read/write Boolean.

EnableItemSelection

When set to False, disables the ability to use the field dropdown in the user interface. The default value is True. Read/write Boolean.

EnableMultiplePageItems

Used for specifying whether or not check boxes are present in the filter drop-down list for fields in the page area. Read/write Boolean.

Formula

Returns or sets a String value that represents the object's formula in A1-style notation and in the language of the macro.

Function

Returns or sets the function used to summarize the PivotTable field (data fields only). Read/write XlConsolidationFunction.

GroupLevel

Returns the placement of the specified field within a group of fields (if the field is a member of a grouped set of fields). Read-only.

Hidden

This property is used to hide the individual levels of an OLAP hierarchy. Read/write Boolean.

HiddenItems

Returns an object that represents either a single hidden PivotTable item (a PivotItem object) or a collection of all the hidden items (a PivotItems object) in the specified field. Read-only.

HiddenItemsList

Returns or sets a Variant specifying an array of strings that are hidden items for a PivotTable field. Read/write.

IncludeNewItemsInFilter

Allows developers to specify whether excluded or included items should be tracked when manual filtering is applied to the PivotField. Read/write Boolean.

IsCalculated

True if the PivotTable field is a calculated field or item. Read-only Boolean.

IsMemberProperty

Returns True when the PivotField contains member properties. Read-only Boolean.

LabelRange

Returns a Range object that represents the cell (or cells) that contain the field label. Read-only

LayoutBlankLine

True if a blank row is inserted after the specified row field in a PivotTable report. The default value is False. Read/write Boolean.

LayoutCompactRow

Specifies whether or not a PivotField is compacted (items of multiple PivotFields are displayed in a single column) when rows are selected. Read/write Boolean.

LayoutForm

Returns or sets the way the specified PivotTable items appear—in table format or in outline format. Read/write XlLayoutFormType.

LayoutPageBreak

True if a page break is inserted after each field. The default value is False. Read/write Boolean.

LayoutSubtotalLocation

Returns or sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field. Read/write XlSubtototalLocationType.

MemberPropertyCaption

Setting the MemberPropertyCaption property controls which member property is used as caption for a given level. Read/write Boolean.

MemoryUsed

Returns the amount of memory currently being used by the object, in bytes. Read-only Long.

Name

Returns or sets a String value representing the name of the object.

NumberFormat

Returns or sets a String value that represents the format code for the object.

Orientation

Returns or sets a XlPivotFieldOrientation value that represents the location of the field in the specified PivotTable report.

Parent

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

ParentField

Returns a PivotField object that represents the PivotTable field that’s the group parent of the specified object. The field must be grouped and must have a parent field. Read-only.

ParentItems

Returns an object that represents either a single PivotTable item (a PivotItem object) or a collection of all the items (a PivotItems object) that are group parents in the specified field. The specified field must be a group parent of another field. Read-only.

PivotFilters

Returns or sets the PivotFilters for the specified PivotField object. Read-only.

Position

Returns or sets a Variant value that represents the position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data).

PropertyOrder

Valid only for PivotTable fields that are member property fields. Returns a Long indicating the display position of the member property within the cube field to which it belongs. Read/write.

PropertyParentField

Returns a PivotField object representing the field to which the properties in this field pertain.

RepeatLabels

Returns or sets whether item labels are repeated in the PivotTable for the specified PivotField. Read/write

ServerBased

True if the data source for the specified PivotTable report is external and only the items matching the page field selection are retrieved. Read/write Boolean.

ShowAllItems

True if all items in the PivotTable report are displayed, even if they don’t contain summary data. The default value is False. Read/write Boolean.

ShowDetail

Gets or sets whether the specified PivotField is showing detail. Read/write Boolean.

ShowingInAxis

Indicates if the PivotField is currently visible in the PivotTable or not. Read-only.

SourceCaption

The SourceCaption property is applicable only for OLAP PivotTables, and returns the original caption from the OLAP server for a PivotField. Read-only.

SourceName

Returns a String value that represents the specified object’s name as it appears in the original source data for the specified PivotTable report.

StandardFormula

Returns or sets a String specifying formulas with standard English (United States) formatting. Read/write.

SubtotalName

Returns or sets the text string label displayed in the subtotal column or row heading in the specified PivotTable report. The default value is the string "Subtotal". Read/write String.

Subtotals

Returns or sets subtotals displayed with the specified field. Valid only for nondata fields. Read/write Variant.

TotalLevels

Returns the total number of fields in the current field group. If the field isn’t grouped, or if the data source is OLAP-based, TotalLevels returns the value 1. Read-only Long.

UseMemberPropertyAsCaption

This property is used to control whether member property captions are used for PivotItem captions of the PivotField. Read/write Boolean.

Value

Returns or sets a String value that represents the name of the specified field in the PivotTable report.

VisibleItems

Returns an object that represents either a single visible PivotTable item (a PivotItem object) or a collection of all the visible items (a PivotItems object) in the specified field. Read-only.

VisibleItemsList

Returns or sets a Variant specifying an array of strings that represent included items in a manual filter applied to a PivotField. Read/write.

Show:
© 2015 Microsoft