PivotField Members

  • Article

Include Protected Members
Include Inherited Members

Represents a field in a PivotTable report. The PivotField object is a member of the PivotFields collection. The PivotFields collection contains all the fields in a PivotTable report, including hidden fields.

The PivotField type exposes the following members.

Properties

  Name Description
Public property _Default Reserved for internal use.
Public property AllItemsVisible Retrieves a value that indicates whether or not any manual filtering is applied to the Pivotfield. Read-only.
Public property Application Returns an _Application object that represents the Microsoft Excel application. Read-only.
Public property AutoShowCount Returns the number of top or bottom items that are automatically shown in the specified PivotTable field. Read-only Integer.
Public property 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.
Public property 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 Integer.
Public property AutoShowType Returns xlAutomatic if AutoShow is enabled for the specified PivotTable field; returns xlManual if AutoShow is disabled. Read-only Integer.
Public property AutoSortCustomSubtotal Returns an integer corresponding to the custom subtotal used to sort the specified PivotTable field automatically. Read-only.
Public property AutoSortField Returns the name of the data field used to sort the specified PivotTable field automatically. Read-only String.
Public property AutoSortOrder Returns the order used to sort the specified PivotTable field automatically. Can be one of the XlSortOrder constants. Read-only Integer.
Public property AutoSortPivotLine Returns the PivotLine used to sort the specified PivotTable field automatically. Read-only.
Public property BaseField Returns or sets the base field for a custom calculation. This property is valid only for data fields. Read/write Object.
Public property BaseItem Returns or sets the item in the base field for a custom calculation. Valid only for data fields. Read/write Object.
Public property Calculation Returns or sets the type of calculation performed by the specified field. This property is valid only for data fields. Read/write XlPivotFieldCalculation.
Public property Caption The label text for the pivot field. Read-only String.
Public property 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.
Public property 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.
Public property Creator Returns a 32-bit integer that indicates the application in which this object was created. If the object was created in Microsoft Excel, this property returns the string XCEL, which is equivalent to the hexadecimal number 5843454C. Read-only XlCreator.
Public property CubeField Returns the CubeField object from which the specified PivotTable field is descended. Read-only.
Public property CurrentPage Returns or sets the current page showing for the page field (valid only for page fields). Read/write Object.
Public property 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 Object.
Public property 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.
Public property 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.
Public property DataRange Returns a Range object. Read-only.
Public property DataType Returns a constant describing the type of data in the PivotTable field. Read-only XlPivotFieldDataType.
Public property DisplayAsCaption This property is used to display member properties of PivotFields as captions. Read-only.
Public property DisplayAsTooltip This property is used to specify whether or not a specific member property PivotField is displayed in tooltips. Read/write.
Public property DisplayInReport This property is used to specify whether the specified member property PivotField is displayed in the PivotTable or not. Read/write.
Public property DragToColumn True if the specified field can be dragged to the column position. The default value is True. Read/write Boolean.
Public property DragToData True if the specified field can be dragged to the data position. The default value is True. Read/write Boolean.
Public property DragToHide True if the field can be hidden by being dragged off the PivotTable report. The default value is True. Read/write Boolean.
Public property DragToPage True if the field can be dragged to the page position. The default value is True. Read/write Boolean.
Public property DragToRow True if the field can be dragged to the row position. The default value is True. Read/write Boolean.
Public property DrilledDown True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible). Read/write Boolean.
Public property 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.
Public property 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.
Public property Formula Returns or sets the object's formula in A1-style notation Read/write String.
Public property Function Returns or sets the function used to summarize the PivotTable field (data fields only). Read/write XlConsolidationFunction.
Public property 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.
Public property Hidden This property is used to hide the individual levels of an OLAP hierarchy. Read/write.
Public property 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.
Public property HiddenItemsList Returns or sets an Object specifying an array of strings that are hidden items for a PivotTable field. Read/write.
Public property IncludeNewItemsInFilter Allows developers to specify whether excluded or included items should be tracked when manual filtering is applied to the PivotField. Read/write.
Public property IsCalculated True if the PivotTable field or PivotTable item is a calculated field or item. Read-only Boolean.
Public property IsMemberProperty Returns True when the PivotField contains member properties. Read-only Boolean.
Public property LabelRange For a PivotField object, returns a Range object that represents the cell (or cells) that contain the field label. For a PivotItem object, returns a Range object that represents all the cells in the PivotTable report that contain the item. Read-only.
Public property 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.
Public property 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.
Public property LayoutForm Returns or sets the way the specified PivotTable items appear — in table format or in outline format. Read/write XlLayoutFormType.
Public property LayoutPageBreak True if a page break is inserted after each field. The default value is False. Read/write Boolean.
Public property LayoutSubtotalLocation Returns or sets the position of the PivotTable field subtotals in relation to (either above or below) the specified field. Read/write XlSubtototalLocationType.
Public property MemberPropertyCaption Setting the MemberPropertyCaption property controls which member property is used as caption for a given level. Read/write.
Public property MemoryUsed Returns the amount of memory in bytes currently being used by the object. Read-only Integer.
Public property Name Returns or sets the name of the object. Read/write String.
Public property NumberFormat Returns or sets the format code for the object. Read/write String.
Public property Orientation The location of the field in the specified PivotTable report. Read/write XlPivotFieldOrientation.
Public property Parent Returns the parent object for the specified object. Read-only.
Public property 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.
Public property 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.
Public property PivotFilters Returns or sets the PivotFilters for the specified PivotField object. Read-only.
Public property Position Position of the field (first, second, third, and so on) among all the fields in its orientation (Rows, Columns, Pages, Data). Read/write Object.
Public property PropertyOrder Valid only for PivotTable fields that are member property fields. Returns an Integer indicating the display position of the member property within the cube field to which it belongs. Read/write.
Public property PropertyParentField Returns a PivotField object representing the field to which the properties in this field pertain.
Public property RepeatLabels Gets or sets whether item labels are repeated in the PivotTable for the specified PivotField.
Public property 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.
Public property 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.
Public property ShowDetail Gets or sets whether the specified PivotField is showing detail. Read/write.
Public property ShowingInAxis Indicates if the PivotField is currently visible in the PivotTable or not. Read-only.
Public property SourceCaption The SourceCaption property is applicable only for OLAP PivotTables, and returns the original caption from the OLAP server for a PivotField. Read-only.
Public property SourceName Returns the specified object’s name as it appears in the original source data for the specified PivotTable report. This might be different from the current item name if the user renamed the item after creating the PivotTable report. Read-only String.
Public property StandardFormula Returns or sets a String specifying formulas with standard English (United States) formatting. Read/write.
Public property 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.
Public property Subtotals Returns or sets subtotals displayed with the specified field. Valid only for non-data fields. Read/write Object.
Public property 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 Integer.
Public property UseMemberPropertyAsCaption This property is used to control whether member property captions are used for PivotItem captions of the PivotField(). Read/write.
Public property Value The name of the specified field in the PivotTable report. Read/write String.
Public property 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.
Public property VisibleItemsList Returns or sets a Object specifying an array of strings that represent included items in a manual filter applied to a PivotField. Read/write.

Top

Methods

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

Top

See Also

Reference

PivotField Interface

Microsoft.Office.Interop.Excel Namespace