Consolidation Class

Defines the Consolidation Class.When the object is serialized out as xml, its qualified name is x:consolidation.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.Consolidation

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(RangeSets))> _
<ChildElementInfoAttribute(GetType(Pages))> _
Public Class Consolidation _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Consolidation
[ChildElementInfoAttribute(typeof(RangeSets))]
[ChildElementInfoAttribute(typeof(Pages))]
public class Consolidation : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • Pages <x:pages>

  • RangeSets <x:rangeSets>

[ISO/IEC 29500-1 1st Edition]

18.10.1.20 consolidation (Consolidation Source)

Represents the description of the PivotCache source using multiple consolidation ranges. This element is used when the source of the PivotTable is a collection of ranges in the workbook. The ranges are specified in the rangeSets collection. The logic for how the application consolidates the data in the ranges is application-defined. [Example: the application might consolidate data based on its position in the worksheet that the end-user specifies. end example]

Parent Elements

cacheSource (§18.10.1.7)

Child Elements

Subclause

pages (Page Item Values)

§18.10.1.65

rangeSets (Range Sets)

§18.10.1.80

Attributes

Description

autoPage (Auto Page)

Specifies a boolean value that indicates whether the application will automatically create one additional page field to describe/qualify the source ranges.

A value of 1 or true indicates the application will create an additional page field.

A value of 0 or false indicates will not create an additional page field.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

[Note: The W3C XML Schema definition of this element’s content model (CT_Consolidation) is located in §A.2. end note]

© ISO/IEC29500: 2008.

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.

See Also

Reference

Consolidation Members

DocumentFormat.OpenXml.Spreadsheet Namespace