PivotTableUISettings class
Defines the PivotTableUISettings Class.This class is only available in O15. When the object is serialized out as xml, its qualified name is x15:pivotTableUISettings.
Inheritance hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Office15.Excel.PivotTableUISettings
Namespace: DocumentFormat.OpenXml.Office15.Excel
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList), FileFormatVersions.Office15)> _
<OfficeAvailabilityAttribute(FileFormatVersions.Office15)> _
<ChildElementInfoAttribute(GetType(FieldListActiveTabTopLevelEntity), FileFormatVersions.Office15)> _
Public Class PivotTableUISettings _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotTableUISettings
[ChildElementInfoAttribute(typeof(ExtensionList), FileFormatVersions.Office15)]
[OfficeAvailabilityAttribute(FileFormatVersions.Office15)]
[ChildElementInfoAttribute(typeof(FieldListActiveTabTopLevelEntity), FileFormatVersions.Office15)]
public class PivotTableUISettings : OpenXmlCompositeElement
Remarks
2.4.49 pivotTableUISettings
Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/11/main
A CT_PivotTableUISettings element that specifies state of the PivotTable field list for this PivotTable ([ISO/IEC-29500-1] section 18.10).
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.
<xsd:element name="pivotTableUISettings" type="CT_PivotTableUISettings"/>
See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
2.6.104 CT_PivotTableUISettings
Target namespace: https://schemas.microsoft.com/office/spreadsheetml/2010/11/main
Referenced by: pivotTableUISettings
Specifies state for user interface used to construct and manipulate a PivotTable.
Child Elements:
activeTabTopLevelEntity: A CT_FieldListActiveTabTopLevelEntity element that specifies a field which appears in the users’s working set of fields in the PivotTable field list.
extLst: A CT_ExtensionList ([ISO/IEC-29500-4] section A.2) element that specifies future extensibility for this element.
Attributes:
allTabSelected: A boolean attribute that specifies whether all fields are displayed in the PivotTable field list.
groupRelatedTables: A boolean ([XMLSCHEMA2] section 3.2.2) attribute that specifies whether related tables are grouped in the PivotTable field list.
sourceDataName: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the name of the primary data connection for the PivotTable. See connection ([ISO/IEC-29500-1] section 18.13.1)
filteredRelationship: An ST_DataModelFilterType attribute that specifies the type of object that is used in an inclusive filter in the PivotTable field list.
filteredName: An ST_Xstring ([ISO/IEC-29500-1] section 22.9.2.19) attribute that specifies the name of the object that is used in an inclusive filter in the PivotTable field list. Objects having the type specified by filteredRelationship and having a name that matches this attribute will be displayed in the filtered PivotTable field list.
The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.
<xsd:complexType name="CT_PivotTableUISettings">
<xsd:sequence>
<xsd:element name="activeTabTopLevelEntity" type="CT_FieldListActiveTabTopLevelEntity" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="extLst" type="x:CT_ExtensionList" minOccurs="0" maxOccurs="1"/>
</xsd:sequence>
<xsd:attribute name="allTabSelected" type="xsd:boolean" use="optional" default="false"/>
<xsd:attribute name="groupRelatedTables" type="xsd:boolean" use="optional" default="true"/>
<xsd:attribute name="sourceDataName" type="xsd:string" use="optional"/>
<xsd:attribute name="filteredRelationship" type="ST_DataModelFilterType" use="optional" default="none"/>
<xsd:attribute name="filteredName" type="xsd:string" use="optional"/>
</xsd:complexType>
See section 5.3 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).
Thread safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.