# PivotFieldType complexType

Contains information about a PivotField.

## Type Information

Namespace | urn:schemas-microsoft-com:office:excel
Schema name | XML Spreadsheet 2000

## Elements and Attributes

### Child Elements

Element | Description
--- | ---
DataField | Indicates that the PivotField element contains information for the data field of the report.
Name | Specifies the name of the PivotField. Also specifies the field in the data source that the PivotField represents. If the name of the PivotField and the name of the field in the data source are different, the SourceName element must also be used.
MapChildItems | Specifies the group to which mapped PivotItem belongs.
AutoShowCount | Contains a number indicating what PivotItems to display based on the values of the PivotItems. Used in conjunction with AutoShowField, AutoShowRange and AutoShowType.
AutoShowField | Specifies the name of the PivotField in the data area of the PivotTable report from which to get the PivotItem value to be used when determining whether a PivotItem should be displayed or not. Used in conjunction with AutoShowCount, AutoShowRange and AutoShowType.
AutoShowRange | Contains an enumeration indicating which range of values to use in determining whether a PivotItem should be displayed or not. Used in conjunction with AutoShowCount, AutoShowField and AutoShowType.
AutoShowType | Contains an enumeration indicating whether all PivotItems are displayed for a PivotField or whether the PivotItems displayed are based on the value falling within a user-specified range. Used in conjunction with AutoShowCount, AutoShowField and AutoShorRange.
AutoSortOrder | Contains an enumeration indicating how PivotItems, for this PivotField, are sorted in the PivotTable report. Used in conjunction with AutoSortField.
AutoSortField | Specifies the name of the PivotField being used to determine the sort order of the PivotItems in this PivotField.
BaseField | Specifies the name of the PivotField that this PivotField is derived from. Used for PivotFields in the data area and for PivotFields that have had their PivotItems grouped.
BaseItem | Specifies the name of the PivotItem that this PivotField is derived from. Used for PivotFields in the data area for certain calculation types. Used in conjunction with BaseField and Calculation.
BlankLineAfterItems | Specifies that a blank line is to be inserted after each change in value.
Calculation | Contains an enumeration indicating the type of calculation being done for the PivotField that is in the data area of the PivotTable report.
CantGetUniqueItems | Contains a Boolean indicating that a list of unique items from the data source for this PivotField was unavailable.
GroupBy | Specifies the size of the groups for PivotItems when PivotItems have been grouped. Used in conjunction with GroupStart, GroupEnd, GroupStartAuto, GroupEndAuto, GroupType, ParentField and BaseField.
GroupStart | Indicates the first PivotItem of the first group when the PivotItems of a PivotField have been grouped. Used in conjunction with GroupBy, GroupEnd, GroupStartAuto, GroupEndAuto, GroupType, ParentField and BaseField.
GroupEnd | Indicates the last PivotItem of the last group when PivotItems have been grouped. Used in conjunction with GroupBy, GroupStart, GroupStartAuto, GroupEndAuto, GroupType, ParentField and BaseField.
GroupStartAuto | Indicates that the first PivotItem of the first group should be picked automatically when the PivotItems of a PivotField have been grouped. Used in conjunction with GroupBy, GroupEnd, GroupStart, GroupEndAuto, GroupType, ParentField and BaseField.
GroupEndAuto | Indicates that the last PivotItem of the last group should be picked automatically when the PivotItems of a PivotField have been grouped. Used in conjunction with GroupBy, GroupEnd, GroupStart, GroupStartAuto, GroupType, ParentField and BaseField.
GroupType | Contains an enumeration that indicates how the PivotItems of this PivotField are grouped.
LayoutPageBreak | A Boolean indicating that a page break should be placed after each change in value for this PivotField.
NumberFormat | Specifies the display formatting to use when displaying the PivotItem or aggregate value.
ParentField | Specifies the name of the PivotField that is the parent (one level up) of this lower-level grouped PivotField. Used in conjunction with GroupBy, GroupEnd, GroupStart, GroupStartAuto, GroupType, GroupEnd and BaseField.
SourceName | Specifies the field in the data source that the PivotField represents. Not required if the name element of the PivotField matches the field name in the data source.
Orientation | Specifies whether the field is to be used for row headers, column headers, page area, as data, or is hidden.
Function | Contains an aggregation to be performed to calculate the value in the cell.
Subtotal | Contains an enumeration indicating a type of subtotal to show for the PivotField. This element can appear multiple times specifying different subtotal types.
LayoutForm | Specifies how items appear in a PivotTable report.
LayoutSubtotalLocation | Specifies where subtotals are displayed in a PivotTable report.
NoDragToRow | Specifies that the field cannot be dragged to create column headers.
NoDragToColumn | Specifies that the field cannot be dragged to create row headers.
NoDragToData | Specifies that the field cannot be dragged to the data area.
NoDragToHide | Specifies that the field cannot be dragged out of the pivot area.
NoDragToPage | Specifies that the field cannot be dragged to the page area.
MemberProperty | Contains additional information (member property information) about a field in OLAP-based PivotTable view or report.
MemberPropertiesOrder | Specifies the order of a member property if a cube field is associated with multiple OLAP member properties.
HideDropDowns | Contains a Boolean value indicating whether the drop-down list for a field in the PivotTable view should be shown.
DrilledLevel | Contains a Boolean that indicates for a PivotField in an OLAP-based PivotTable whether this PivotField was shown due to the user navigating down an entire hierarchy level.
ServerSortOrder | Contains a Boolean that indicates for a PivotField in an OLAP-based PivotTable whether the order of the PivotItems comes from the server or is determined by Excel.
IsMemberProperty | Contains a Boolean value indicating whether OLAP member property information is displayed for a field.
CurrentPage | Specifies the name of the PivotItem selected for this PivotField when the PivotField is in the page area.
Caption | Specifies the display text or caption for a PivotField in an OLAP-based PivotTable.
FilterMember | Contains information about OLAP cube members that are selected when an OLAP hierarchy is shown in the page area of the PivotTable view.
UniqueName | Specifies a unique name for a OLAP cube member.
Level | Contains the zero-based level index on which an OLAP cube member resides.
Caption | Specifies a caption for the OLAP cube member.
Position | Specifies the order of the fields when several PivotFields are used.
DataType | Specifies the data type of the field.
ServerBased | Contains a Boolean indicating whether the server is queried every time the user changes the selected PivotItem for the PivotField that is in the page area.
ShowAllItems | Contains a Boolean indicating whether all PivotItems should be shown or not even if they have no data.
SQLType | Specifies the data type using SQL Server data types.
SubtotalName | Specifies the custom text to display for the subtotal label for this PivotField.
PLTPivotItem | This element or attribute is not created or processed by Excel. It is designed to be used by external applications and components.
DetailFormat | Specifies the text formatting that is applied to a field when it is on the detail grid.
DetailWidth | Specifies the width of a field (in pixels) when it appears on the detail axis.
Expanded | Specifies whether the field members are expanded by default, or whether a leaf member was expanded.
FilterCaption | Contains the caption of a field set when the field set is the current filter.
Formula | Specifies the formula used to calculate the values for a PivotField in the data area.
FormulaV10 | Contains the string of the Formula element with English locale. This string is generated only generated when the English version of the Formula string is different from the string in the Formula element.
ParseFormulaAsV10 | Specifies that the string in the Formula element is to be processed as if it is an English string (a V10 formula).
GroupedWidth | Specifies the width of a field (in pixels) when on the grouping axis, and whether the column width of a field is set automatically when the field is used on the row or column axis.
NewItemsHidden | Contains a Boolean indicating whether new items from a refresh operation will be hidden by default in the PivotTable report or displayed.
PLCaption | Specifies the contains the caption of a PivotList field.
PLDataOrientation | Specifies whether a field is on the detail grid.
PLGroupType | Specifies whether a field is the Weeks field of a weekly automatic date field set.
PLName | Contains the name of a total when a PivotField element represents a total.
PLPosition | Specifies the position of a field in the detail grid.
PLSubtotal | Contains the subtotal to display when a PivotTable field is not on the column or row axis.
SourceHierarchy | Specifies the name of the hierarchy this PivotField belongs to in an OLAP-based PivotTable.
MemberPropertyParent | Contains an index of the hierarchy level to which a particular OLAP member property applies.
SourceHierarchyLevel | Specifies a number indicating what level in the hierarchy this PivotField belongs to in an OLAP-based PivotTable.
PivotItem | Contains information on an item (PivotItem) in the PivotField.
SubtotalFormat | Specifies the text formatting that is applied to a subtotal.
TotalAlignment | Specifies the horizontal alignment of a total.
TotalCaptionAlignment | Specifies the horizontal alignment of the caption for a total.
TotalWidth | Specifies the width of a total and whether the width is automatically set.

### Attributes

None.

## Definition

    <xsd:complexType name="PivotFieldType" >
      <xsd:sequence>
        <xsd:element name="DataField" minOccurs="0">
        </xsd:element>
        <xsd:element name="Name" type="xsd:string">
        </xsd:element>
        <xsd:element name="MapChildItems" type="MapChildItemsType" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoShowCount" type="xsd:int" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoShowField" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoShowRange" type="AutoShowRangeType" default="Top" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoShowType" type="AutoShowTypeType" default="Manual" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoSortOrder" type="AutoSortOrderType" default="Manual" minOccurs="0">
        </xsd:element>
        <xsd:element name="AutoSortField" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="BaseField" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="BaseItem" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="BlankLineAfterItems" minOccurs="0">
        </xsd:element>
        <xsd:element name="Calculation" type="CalculationPivotFieldType" default="Normal" minOccurs="0">
        </xsd:element>
        <xsd:element name="CantGetUniqueItems" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupBy" type="xsd:int" default="1" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupStart" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupEnd" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupStartAuto" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupEndAuto" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupType" type="GroupTypeType" minOccurs="0">
        </xsd:element>
        <xsd:element name="LayoutPageBreak" minOccurs="0">
        </xsd:element>
        <xsd:element name="NumberFormat" type="NumberFormatType" minOccurs="0">
        </xsd:element>
        <xsd:element name="ParentField" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="SourceName" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="Orientation" type="OrientationType" minOccurs="0">
        </xsd:element>
        <xsd:element name="Function" type="FunctionType" default="Sum" minOccurs="0">
        </xsd:element>
        <xsd:element name="Subtotal" type="SubtotalType" default="Default" minOccurs="0" maxOccurs="unbounded">
        </xsd:element>
        <xsd:element name="LayoutForm" type="LayoutFormType" minOccurs="0">
        </xsd:element>
        <xsd:element name="LayoutSubtotalLocation" type="LayoutSubtotalLocationType" minOccurs="0">
        </xsd:element>
        <xsd:element name="NoDragToRow" minOccurs="0">
        </xsd:element>
        <xsd:element name="NoDragToColumn" minOccurs="0">
        </xsd:element>
        <xsd:element name="NoDragToData" minOccurs="0">
        </xsd:element>
        <xsd:element name="NoDragToHide" minOccurs="0">
        </xsd:element>
        <xsd:element name="NoDragToPage" minOccurs="0">
        </xsd:element>
        <xsd:element name="MemberProperty" type="MemberPropertyType" minOccurs="0" maxOccurs="unbounded">
        </xsd:element>
        <xsd:element name="MemberPropertiesOrder" minOccurs="0">
        </xsd:element>
        <xsd:element name="HideDropDowns" minOccurs="0">
        </xsd:element>
        <xsd:element name="DrilledLevel" minOccurs="0">
        </xsd:element>
        <xsd:element name="ServerSortOrder" minOccurs="0">
        </xsd:element>
        <xsd:element name="IsMemberProperty" minOccurs="0">
        </xsd:element>
        <xsd:element name="CurrentPage" type="xsd:string" default="All" minOccurs="0">
        </xsd:element>
        <xsd:element name="Caption" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="FilterMember" minOccurs="0" maxOccurs="unbounded">
          <xsd:complexType>
            <xsd:sequence>
              <xsd:element name="UniqueName" type="xsd:string" minOccurs="0">
              </xsd:element>
              <xsd:element name="Level" type="xsd:integer" minOccurs="0">
              </xsd:element>
              <xsd:element name="Caption" type="xsd:string" minOccurs="0">
              </xsd:element>
            </xsd:sequence>
          </xsd:complexType>
        </xsd:element>
        <xsd:element name="Position" type="xsd:int" default="1" minOccurs="0">
        </xsd:element>
        <xsd:element name="DataType" type="DataTypeType" minOccurs="0">
        </xsd:element>
        <xsd:element name="ServerBased" minOccurs="0">
        </xsd:element>
        <xsd:element name="ShowAllItems" minOccurs="0">
        </xsd:element>
        <xsd:element name="SQLType" type="SQLTypeType" default="Character" minOccurs="0">
        </xsd:element>
        <xsd:element name="SubtotalName" type="xsd:string" default="Subtotal" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLTPivotItem" type="PivotItemType" minOccurs="0" maxOccurs="unbounded">
        </xsd:element>
        <xsd:element name="DetailFormat" type="DetailFormatType" minOccurs="0">
        </xsd:element>
        <xsd:element name="DetailWidth" type="xsd:int" minOccurs="0">
        </xsd:element>
        <xsd:element name="Expanded" minOccurs="0">
        </xsd:element>
        <xsd:element name="FilterCaption" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="Formula" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="FormulaV10" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="ParseFormulaAsV10" minOccurs="0">
        </xsd:element>
        <xsd:element name="GroupedWidth" type="xsd:int" default="50" minOccurs="0">
        </xsd:element>
        <xsd:element name="NewItemsHidden" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLCaption" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLDataOrientation" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLGroupType" type="xsd:string" fixed="Weeks" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLName" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLPosition" type="xsd:int" minOccurs="0">
        </xsd:element>
        <xsd:element name="PLSubtotal" type="xsd:double" minOccurs="0">
        </xsd:element>
        <xsd:element name="SourceHierarchy" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="MemberPropertyParent" type="xsd:integer" minOccurs="0">
        </xsd:element>
        <xsd:element name="SourceHierarchyLevel" type="xsd:string" minOccurs="0">
        </xsd:element>
        <xsd:element name="PivotItem" type="PivotItemType" minOccurs="0" maxOccurs="unbounded">
        </xsd:element>
        <xsd:element name="SubtotalFormat" type="SubtotalFormatType" minOccurs="0">
        </xsd:element>
        <xsd:element name="TotalAlignment" type="TotalAlignmentType" default="Automatic" minOccurs="0">
        </xsd:element>
        <xsd:element name="TotalCaptionAlignment" type="TotalCaptionAlignmentType" minOccurs="0">
        </xsd:element>
        <xsd:element name="TotalWidth" type="xsd:int" minOccurs="0">
        </xsd:element>
      </xsd:sequence>
    </xsd:complexType>

©2003-2004 Microsoft Corporation. All rights reserved. Permission to copy, display and distribute this document is available at: http://msdn.microsoft.com/library/en-us/odcXMLRef/html/odcXMLRefLegalNotice.asp