This documentation is archived and is not being maintained.

DataConsolidate Class

Data Consolidate.When the object is serialized out as xml, its qualified name is x:dataConsolidate.

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

[ChildElementInfoAttribute(typeof(DataReferences))]
public class DataConsolidate : OpenXmlCompositeElement

The following table lists the possible child types:

  • DataReferences <x:dataRefs>


[ISO/IEC 29500-1 1st Edition]

18.3.1.29 dataConsolidate (Data Consolidate)

Data consolidation settings. The dataRefs are the set of source ranges containing data to consolidate. The function indicates the function that shall be used to consolidate the data.

[Example:

This example demonstrates consolidating the ranges A1:C1 and A3:C3 by using the 'count' function.


<dataConsolidate function="count">
<dataRefs count="2">
<dataRef ref="A1:C1" sheet="Sheet1"/>
<dataRef ref="A3:C3" sheet="Sheet1"/>
</dataRefs>
</dataConsolidate>


end example]

Parent Elements

worksheet (§18.3.1.99)

Child Elements

Subclause

dataRefs (Data Consolidation References)

§18.3.1.31

Attributes

Description

function (Function Index)

Indicates which function to use when consolidating the ranges.

The possible values for this attribute are defined by the ST_DataConsolidateFunction simple type (§18.18.17).

link (Link)

Create links to source data.

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

startLabels (Use Starting Column Labels)

Use labels in first column. Both startLabels and topLabels can be true at the same time.

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

topLabels (Labels In Top Row)

Use labels in top row. Both leftLabels and topLabels can be true at the same time.

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_DataConsolidate) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: