Headers Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Revision Headers.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:headers.

public class Headers : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Headers = class
    inherit OpenXmlPartRootElement

Public Class Headers
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Headers

Remarks

[ISO/IEC 29500-1 1st Edition]

headers (Revision Headers)

This element represents the list of revision headers.

This section contains many references to history, versions, and revisions, and it is helpful to clarify the relationships here. In general, a series of changes (revisions) can be made to a spreadsheet. When a batch of those revisions is saved to disk, the version number of the spreadsheet is incremented. The batch of changes is saved to the revision history, which is persisted on disk with the file in the form of different log files and headers.

There are some attributes that deal with history which might seem redundant (such as diskRevisions, and history, among others) - these are there for backwards compatibility with older versions of spreadsheet applications and do not need to be used for creating new files.

Child Elements	Subclause
header (Header)	§18.11.1.1

Attributes	Description
diskRevisions (Disk Revisions)	A Boolean value indicating that this shared workbook file contains revisions. True when the workbook does have revisions, false otherwise. [Note: this attribute is used for backwards compatibility. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
exclusive (Exclusive Mode)	A Boolean value indicating that this shared workbook is in exclusive mode. A workbook is in exclusive mode when a user has a lock on it for appending revisions to the file. [Note: This is used for backwards compatibility with older spreadsheet applications. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
guid (Last Revision GUID)	The globally unique identifier of the last set of revisions. This shall match the GUID for the most recent header. The possible values for this attribute are defined by the ST_Guid simple type (§22.9.2.4).
history (History)	A Boolean value indicating that this shared workbook maintains a revision history. True if a history is maintained, false otherwise. [Note: This is used for backwards compatibility with older spreadsheet applications. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
keepChangeHistory (Keep Change History)	A Boolean value indicating whether the revision history should be kept for this shared workbook. True if the history should be kept, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
lastGuid (Last GUID)	Unique identifier of the last set of revisions that was saved into the file. The spreadsheet application can have certain modes, such as a timed save mode, where the application doesn't do a full save, but instead just appends the most recent revision records. In cases like this, for a new user that opens such a file while it is being edited, the file that was loaded from disk only have the changes that were saved during a full save. To get the current state of the file which includes edits by other users, the spreadsheet application would need to apply all the revisions from lastGuid to guid. The possible values for this attribute are defined by the ST_Guid simple type (§22.9.2.4).
preserveHistory (Preserve History)	An integer representing the number of days the spreadsheet application shall keep the change history for this workbook. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
protected (Protected)	A Boolean value indicating whether the change tracking in this shared workbook can be removed. True if the tracking can be removed, false otherwise. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
revisionId (Revision Id)	The current revision number of this shared workbook. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
shared (Shared Workbook)	A Boolean value indicating that this workbook is shared. True when the workbook is shared, false otherwise. [Note: This is used for backwards compatibility with older spreadsheet applications. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
trackRevisions (Track Revisions)	A Boolean value indicating that revisions are tracked in this shared workbook. True when revisions are tracked, false otherwise. [Note: This is used for backwards compatibility with older spreadsheet applications. end note] The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
version (Version)	An integer representing the current version of this shared workbook. The integer should begin counting from 1 for the first version. The possible values for this attribute are defined by the W3C XML Schema int datatype.

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

� ISO/IEC29500: 2008.

Constructors

Headers()	Initializes a new instance of the Headers class.
Headers(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Headers class with the specified child elements.
Headers(OpenXmlElement[])	Initializes a new instance of the Headers class with the specified child elements.
Headers(String)	Initializes a new instance of the Headers class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DiskRevisions	Disk Revisions Represents the following attribute in the schema: diskRevisions
Exclusive	Exclusive Mode Represents the following attribute in the schema: exclusive
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
Guid	Last Revision GUID Represents the following attribute in the schema: guid
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
History	History Represents the following attribute in the schema: history
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
KeepChangeHistory	Keep Change History Represents the following attribute in the schema: keepChangeHistory
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LastGuid	Last GUID Represents the following attribute in the schema: lastGuid
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OpenXmlPart	Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PreserveHistory	Preserve History Represents the following attribute in the schema: preserveHistory
Protected	Protected Represents the following attribute in the schema: protected
RevisionId	Revision Id Represents the following attribute in the schema: revisionId
Shared	Shared Workbook Represents the following attribute in the schema: shared
TrackRevisions	Track Revisions Represents the following attribute in the schema: trackRevisions
Version	Version Represents the following attribute in the schema: version
WorkbookRevisionHeaderPart	Gets the WorkbookRevisionHeaderPart associated with this element.
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
Load(WorkbookRevisionHeaderPart)	Loads the DOM from the WorkbookRevisionHeaderPart
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Reload()	Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
Save()	Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement)
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
Save(WorkbookRevisionHeaderPart)	Saves the DOM into the WorkbookRevisionHeaderPart.
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)