This documentation is archived and is not being maintained.

Header Class

Header.When the object is serialized out as xml, its qualified name is x:header.

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

[ChildElementInfoAttribute(typeof(SheetIdMap))]
[ChildElementInfoAttribute(typeof(ReviewedList))]
[ChildElementInfoAttribute(typeof(ExtensionList))]
public class Header : OpenXmlCompositeElement

The following table lists the possible child types:

  • SheetIdMap <x:sheetIdMap>

  • ReviewedList <x:reviewedList>

  • ExtensionList <x:extLst>


[ISO/IEC 29500-1 1st Edition]

18.11.1.1 header (Header)

This element is essentially a table that contains metadata about a list of specific changes that have taken place for this workbook. It lists when the changes were made, who made them, and the relationship IDs so that the log detailing the specific change can be found. If tracking changes, or sharing workbooks, are enabled, then changes are persisted on the Save event, or at a specified time interval. A header is created for each set of changes.

Parent Elements

Root element of SpreadsheetML Shared Workbook Revision Headers part; headers (§18.11.1.2)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

reviewedList (Reviewed List)

§18.11.1.15

sheetIdMap (Sheet Id Map)

§18.11.1.24

Attributes

Description

dateTime (Date Time)

The date and time when this set of revisions was saved.

[Note: This can happen when the user explicitly saves, or the save can occur due to a time interval, specified in the spreadsheet application, elapsing. end note]

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

guid (GUID)

A globally unique identifier for this set of revisions.

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

id (Relationship ID)

Namespace: .../officeDocument/2006/relationships

This is the ID that is used to find the corresponding log record of the changes made for this header.

Use the corresponding relationship expressed in the revisionHeaders part to locate the log record that lists the specific changes.

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

maxRId (Max Revision Id)

The highest revision Id that belongs to this header.

[Note: This can be used when, given a revision ID, the spreadsheet application needs to determine which revision log to access. end note]

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

maxSheetId (Last Sheet Id)

Internal identifier of the next available sheet in this workbook.

The numbering here is the index of the next available sheet in the workbook in a 1-based index system.

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

minRId (Minimum Revision Id)

The lowest revision id that belongs to this header.

[Note: this can be used when, given a revision ID, the spreadsheet application needs to determine which revision log to access. end note]

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

userName (User Name)

A string representing the name of the user making the revision..

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

[Note: The W3C XML Schema definition of this element’s content model (CT_RevisionHeader) 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: