PivotField Object Members

  • Article
Excel Developer Reference

Represents a field in a PivotTable report.

Methods

  Name Description
Bb256074.methods(en-us,office.12).gif AddPageItem Adds an additional item to a multiple item page field.
Bb256074.methods(en-us,office.12).gif AutoShow Displays the number of top or bottom items for a row, page, or column field in the specified PivotTable report.
Bb256074.methods(en-us,office.12).gif AutoSort Establishes automatic field-sorting rules for PivotTable reports.
Bb256074.methods(en-us,office.12).gif CalculatedItems Returns a CalculatedItems collection that represents all the calculated items in the specified PivotTable report. Read-only.
Bb256074.methods(en-us,office.12).gif 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.
Bb256074.methods(en-us,office.12).gif ClearLabelFilters This method deletes all label filters or all date filters in the PivotFilters collection of the PivotField.
Bb256074.methods(en-us,office.12).gif 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.
Bb256074.methods(en-us,office.12).gif ClearValueFilters Calling this method deletes all value filters in the PivotFilters collection of the PivotField.
Bb256074.methods(en-us,office.12).gif Delete Deletes the object.
Bb256074.methods(en-us,office.12).gif DrillTo The DrillTo method supports drilling to a specified PivotField from another PivotField.
Bb256074.methods(en-us,office.12).gif 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.

Properties

  Name Description
Bb256074.properties(en-us,office.12).gif AllItemsVisible Used to retrieve a Boolean value that indicates whether or not any manual filtering is applied to the PivotField. Read-only.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif AutoShowCount Returns the number of top or bottom items that are automatically shown in the specified PivotTable field. Read-only Long.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif AutoShowType Returns xlAutomatic if AutoShow is enabled for the specified PivotTable field; returns xlManual if AutoShow is disabled. Read-only Long.
Bb256074.properties(en-us,office.12).gif AutoSortCustomSubtotal Returns the name of the custom subtotal used to sort the specified PivotTable field automatically. Read-only.
Bb256074.properties(en-us,office.12).gif AutoSortField Returns the name of the data field used to sort the specified PivotTable field automatically. Read-only String.
Bb256074.properties(en-us,office.12).gif AutoSortOrder Returns the order used to sort the specified PivotTable field automatically. Can be one of the constants of XlSortOrder. Read-only Long.
Bb256074.properties(en-us,office.12).gif AutoSortPivotLine Returns the name of the PivotLine used to sort the specified PivotTable field automatically. Read-only.
Bb256074.properties(en-us,office.12).gif BaseField Returns or sets the base field for a custom calculation. This property is valid only for data fields. Read/write Variant.
Bb256074.properties(en-us,office.12).gif BaseItem Returns or sets the item in the base field for a custom calculation. Valid only for data fields. Read/write Variant.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif Caption Returns a String value that represents the label text for the pivot field.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif Creator Returns a 32-bit integer that indicates the application in which this object was created. Read-only Long.
Bb256074.properties(en-us,office.12).gif CubeField Returns the CubeField object from which the specified PivotTable field is descended. Read-only.
Bb256074.properties(en-us,office.12).gif CurrentPage Returns or sets the current page showing for the page field (valid only for page fields). Read/write PivotItem.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif DataRange Returns a Range object as shown in the following table. Read-only.
Bb256074.properties(en-us,office.12).gif DataType Returns a XlPivotFieldDataType value that represents the type of data in the PivotTable field.
Bb256074.properties(en-us,office.12).gif DisplayAsCaption This property is used to display member properties of PivotFields as captions. Read-only.
Bb256074.properties(en-us,office.12).gif DisplayAsTooltip This property is used to specify whether or not a specific member property PivotField is displayed in tooltips. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DisplayInReport This property is used to specify whether the specified member property PivotField is displayed in the PivotTable or not. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DragToColumn True if the specified field can be dragged to the column position. The default value is True. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DragToData True if the specified field can be dragged to the data position. The default value is True. Read/write Boolean
Bb256074.properties(en-us,office.12).gif DragToHide True if the field can be hidden by being dragged off the PivotTable report. The default value is True. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DragToPage True if the field can be dragged to the page position. The default value is True. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DragToRow True if the field can be dragged to the row position. The default value is True. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif DrilledDown True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible). Read/write Boolean.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif Formula Returns or sets a String value that represents the object's formula in A1-style notation and in the language of the macro.
Bb256074.properties(en-us,office.12).gif Function Returns or sets the function used to summarize the PivotTable field (data fields only). Read/write XlConsolidationFunction.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif Hidden This property is used to hide the individual levels of an OLAP hierarchy. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif HiddenItemsList Returns or sets a Variant specifying an array of strings that are hidden items for a PivotTable field. Read/write.
Bb256074.properties(en-us,office.12).gif IncludeNewItemsInFilter This property allows developers to specify whether excluded or included items should be tracked when manual filtering is applied to the PivotField. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif IsCalculated True if the PivotTable field is a calculated field or item. Read-only Boolean.
Bb256074.properties(en-us,office.12).gif IsMemberProperty Returns True when the PivotField contains member properties. Read-only Boolean.
Bb256074.properties(en-us,office.12).gif LabelRange Returns a Range object that represents the cell (or cells) that contain the field label. Read-only
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif LayoutForm Returns or sets the way the specified PivotTable items appear—in table format or in outline format. Read/write XlLayoutFormType.
Bb256074.properties(en-us,office.12).gif LayoutPageBreak True if a page break is inserted after each field. The default value is False. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif LayoutSubtotalLocation Returns or sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field. Read/write XlSubtototalLocationType.
Bb256074.properties(en-us,office.12).gif MemberPropertyCaption Setting the MemberPropertyCaption property controls which member property is used as caption for a given level. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif MemoryUsed Returns the amount of memory currently being used by the object, in bytes. Read-only Long.
Bb256074.properties(en-us,office.12).gif Name Returns or sets a String value representing the name of the object.
Bb256074.properties(en-us,office.12).gif NumberFormat Returns or sets a String value that represents the format code for the object.
Bb256074.properties(en-us,office.12).gif Orientation Returns or sets a XlPivotFieldOrientation value that represents the location of the field in the specified PivotTable report.
Bb256074.properties(en-us,office.12).gif Parent Returns the parent object for the specified object. Read-only.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif PivotFilters Returns or sets the PivotFilters for the specified PivotField object. Read-only.
Bb256074.properties(en-us,office.12).gif 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).
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif PropertyParentField Returns a PivotField object representing the field to which the properties in this field pertain.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif ShowDetail Gets or sets whether the specified PivotField is showing detail. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif ShowingInAxis Indicates if the PivotField is currently visible in the PivotTable or not. Read-only.
Bb256074.properties(en-us,office.12).gif SourceCaption The SourceCaption property is applicable only for OLAP PivotTables, and returns the original caption from the OLAP server for a PivotField. Read-only.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif StandardFormula Returns or sets a String specifying formulas with standard English (United States) formatting. Read/write.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif Subtotals Returns or sets subtotals displayed with the specified field. Valid only for nondata fields. Read/write Variant.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif UseMemberPropertyAsCaption This property is used to control whether member property captions are used for PivotItem captions of the PivotField. Read/write Boolean.
Bb256074.properties(en-us,office.12).gif Value Returns or sets a String value that represents the name of the specified field in the PivotTable report.
Bb256074.properties(en-us,office.12).gif 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.
Bb256074.properties(en-us,office.12).gif 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.