Header Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Header.

This class is available in Office 2007 and above.

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

public class Header : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Header = class
    inherit OpenXmlPartRootElement

Public Class Header
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Header

Remarks

[ISO/IEC 29500-1 1st Edition]

hdr (Header)

This element specifies the content for a single header for use within one or more sections of a WordprocessingML document.

Within the hdr element, the content of the element is similar to the content of the body (§17.2.2) element, and contains what is referred to as block-level markup - markup which can exist as a sibling element to paragraphs in a WordprocessingML document.

[Example: Consider the following simple one page document with one header:

88f5cf14-b052-4a97-ab3f-7e52ce0c959f

This document defines one header with the text Header. The header's contents is stored in a unique Header part. The resulting header is represented by the following WordprocessingML:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Header</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Since headers are containers of block level contents, all block level elements can be used within them. In this particular example, the content is a single paragraph. end example]

[Example: Consider a more complex three page document with different first, odd, and even page headers defined:

678d902e-6383-428e-a110-0095e3dc75bf

This document defines three headers stored in three different header parts. The resulting headers are represented by the following WordprocessingML:

First page header part:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
First</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Even page header part:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Even</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

Odd page header part:

<w:hdr>  
  <w:p>  
    <w:r>  
      <w:t>  
Odd</w:t>  
    </w:r>  
  </w:p>  
</w:hdr>  

end example]

Parent Elements
Root element of WordprocessingML Header part

Child Elements	Subclause
altChunk (Anchor for Imported External Content)	§17.17.2.1
bookmarkEnd (Bookmark End)	§17.13.6.1
bookmarkStart (Bookmark Start)	§17.13.6.2
commentRangeEnd (Comment Anchor Range End)	§17.13.4.3
commentRangeStart (Comment Anchor Range Start)	§17.13.4.4
customXml (Block-Level Custom XML Element)	§17.5.1.6
customXmlDelRangeEnd (Custom XML Markup Deletion End)	§17.13.5.4
customXmlDelRangeStart (Custom XML Markup Deletion Start)	§17.13.5.5
customXmlInsRangeEnd (Custom XML Markup Insertion End)	§17.13.5.6
customXmlInsRangeStart (Custom XML Markup Insertion Start)	§17.13.5.7
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End)	§17.13.5.8
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start)	§17.13.5.9
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End)	§17.13.5.10
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start)	§17.13.5.11
del (Deleted Run Content)	§17.13.5.14
ins (Inserted Run Content)	§17.13.5.18
moveFrom (Move Source Run Content)	§17.13.5.22
moveFromRangeEnd (Move Source Location Container - End)	§17.13.5.23
moveFromRangeStart (Move Source Location Container - Start)	§17.13.5.24
moveTo (Move Destination Run Content)	§17.13.5.25
moveToRangeEnd (Move Destination Location Container - End)	§17.13.5.27
moveToRangeStart (Move Destination Location Container - Start)	§17.13.5.28
oMath (Office Math)	§22.1.2.77
oMathPara (Office Math Paragraph)	§22.1.2.78
p (Paragraph)	§17.3.1.22
permEnd (Range Permission End)	§17.13.7.1
permStart (Range Permission Start)	§17.13.7.2
proofErr (Proofing Error Anchor)	§17.13.8.1
sdt (Block-Level Structured Document Tag)	§17.5.2.29
tbl (Table)	§17.4.38

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
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)
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)
HeaderPart	Gets the HeaderPart associated with this element.
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)
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)
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)
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(HeaderPart)	Loads the DOM from the HeaderPart
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(HeaderPart)	Saves the DOM into the HeaderPart.
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
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)