Footer Class (DocumentFormat.OpenXml.Wordprocessing)

Article
08/03/2013

Footer. It is the root element of FooterPart.When the object is serialized out as xml, its qualified name is w:ftr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.OpenXmlPartRootElement
        DocumentFormat.OpenXml.Wordprocessing.Footer

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(RunConflictDeletion), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(AltChunk))> _
<ChildElementInfoAttribute(GetType(CustomXmlBlock))> _
<ChildElementInfoAttribute(GetType(SdtBlock))> _
<ChildElementInfoAttribute(GetType(Paragraph))> _
<ChildElementInfoAttribute(GetType(Table))> _
<ChildElementInfoAttribute(GetType(ProofError))> _
<ChildElementInfoAttribute(GetType(PermStart))> _
<ChildElementInfoAttribute(GetType(PermEnd))> _
<ChildElementInfoAttribute(GetType(BookmarkStart))> _
<ChildElementInfoAttribute(GetType(BookmarkEnd))> _
<ChildElementInfoAttribute(GetType(CommentRangeStart))> _
<ChildElementInfoAttribute(GetType(CommentRangeEnd))> _
<ChildElementInfoAttribute(GetType(MoveFromRangeStart))> _
<ChildElementInfoAttribute(GetType(MoveFromRangeEnd))> _
<ChildElementInfoAttribute(GetType(MoveToRangeStart))> _
<ChildElementInfoAttribute(GetType(MoveToRangeEnd))> _
<ChildElementInfoAttribute(GetType(CustomXmlInsRangeStart))> _
<ChildElementInfoAttribute(GetType(CustomXmlInsRangeEnd))> _
<ChildElementInfoAttribute(GetType(CustomXmlDelRangeStart))> _
<ChildElementInfoAttribute(GetType(CustomXmlDelRangeEnd))> _
<ChildElementInfoAttribute(GetType(CustomXmlMoveFromRangeStart))> _
<ChildElementInfoAttribute(GetType(CustomXmlMoveFromRangeEnd))> _
<ChildElementInfoAttribute(GetType(CustomXmlMoveToRangeStart))> _
<ChildElementInfoAttribute(GetType(CustomXmlMoveToRangeEnd))> _
<ChildElementInfoAttribute(GetType(CustomXmlConflictInsertionRangeStart), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(CustomXmlConflictInsertionRangeEnd), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(CustomXmlConflictDeletionRangeStart), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(CustomXmlConflictDeletionRangeEnd), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(InsertedRun))> _
<ChildElementInfoAttribute(GetType(DeletedRun))> _
<ChildElementInfoAttribute(GetType(MoveFromRun))> _
<ChildElementInfoAttribute(GetType(MoveToRun))> _
<ChildElementInfoAttribute(GetType(ContentPart), FileFormatVersions.Office2010)> _
<ChildElementInfoAttribute(GetType(RunConflictInsertion), FileFormatVersions.Office2010)> _
Public Class Footer _
    Inherits OpenXmlPartRootElement
'Usage
Dim instance As Footer

[ChildElementInfoAttribute(typeof(RunConflictDeletion), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(AltChunk))]
[ChildElementInfoAttribute(typeof(CustomXmlBlock))]
[ChildElementInfoAttribute(typeof(SdtBlock))]
[ChildElementInfoAttribute(typeof(Paragraph))]
[ChildElementInfoAttribute(typeof(Table))]
[ChildElementInfoAttribute(typeof(ProofError))]
[ChildElementInfoAttribute(typeof(PermStart))]
[ChildElementInfoAttribute(typeof(PermEnd))]
[ChildElementInfoAttribute(typeof(BookmarkStart))]
[ChildElementInfoAttribute(typeof(BookmarkEnd))]
[ChildElementInfoAttribute(typeof(CommentRangeStart))]
[ChildElementInfoAttribute(typeof(CommentRangeEnd))]
[ChildElementInfoAttribute(typeof(MoveFromRangeStart))]
[ChildElementInfoAttribute(typeof(MoveFromRangeEnd))]
[ChildElementInfoAttribute(typeof(MoveToRangeStart))]
[ChildElementInfoAttribute(typeof(MoveToRangeEnd))]
[ChildElementInfoAttribute(typeof(CustomXmlInsRangeStart))]
[ChildElementInfoAttribute(typeof(CustomXmlInsRangeEnd))]
[ChildElementInfoAttribute(typeof(CustomXmlDelRangeStart))]
[ChildElementInfoAttribute(typeof(CustomXmlDelRangeEnd))]
[ChildElementInfoAttribute(typeof(CustomXmlMoveFromRangeStart))]
[ChildElementInfoAttribute(typeof(CustomXmlMoveFromRangeEnd))]
[ChildElementInfoAttribute(typeof(CustomXmlMoveToRangeStart))]
[ChildElementInfoAttribute(typeof(CustomXmlMoveToRangeEnd))]
[ChildElementInfoAttribute(typeof(CustomXmlConflictInsertionRangeStart), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(CustomXmlConflictInsertionRangeEnd), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(CustomXmlConflictDeletionRangeStart), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(CustomXmlConflictDeletionRangeEnd), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(InsertedRun))]
[ChildElementInfoAttribute(typeof(DeletedRun))]
[ChildElementInfoAttribute(typeof(MoveFromRun))]
[ChildElementInfoAttribute(typeof(MoveToRun))]
[ChildElementInfoAttribute(typeof(ContentPart), FileFormatVersions.Office2010)]
[ChildElementInfoAttribute(typeof(RunConflictInsertion), FileFormatVersions.Office2010)]
public class Footer : OpenXmlPartRootElement

Remarks

The following table lists the possible child types:

AltChunk <w:altChunk>
CustomXmlBlock <w:customXml>
SdtBlock <w:sdt>
Paragraph <w:p>
Table <w:tbl>
ProofError <w:proofErr>
PermStart <w:permStart>
PermEnd <w:permEnd>
BookmarkStart <w:bookmarkStart>
BookmarkEnd <w:bookmarkEnd>
CommentRangeStart <w:commentRangeStart>
CommentRangeEnd <w:commentRangeEnd>
MoveFromRangeStart <w:moveFromRangeStart>
MoveFromRangeEnd <w:moveFromRangeEnd>
MoveToRangeStart <w:moveToRangeStart>
MoveToRangeEnd <w:moveToRangeEnd>
CustomXmlInsRangeStart <w:customXmlInsRangeStart>
CustomXmlInsRangeEnd <w:customXmlInsRangeEnd>
CustomXmlDelRangeStart <w:customXmlDelRangeStart>
CustomXmlDelRangeEnd <w:customXmlDelRangeEnd>
CustomXmlMoveFromRangeStart <w:customXmlMoveFromRangeStart>
CustomXmlMoveFromRangeEnd <w:customXmlMoveFromRangeEnd>
CustomXmlMoveToRangeStart <w:customXmlMoveToRangeStart>
CustomXmlMoveToRangeEnd <w:customXmlMoveToRangeEnd>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictInsertionRangeStart <w14:customXmlConflictInsRangeStart>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictInsertionRangeEnd <w14:customXmlConflictInsRangeEnd>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictDeletionRangeStart <w14:customXmlConflictDelRangeStart>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictDeletionRangeEnd <w14:customXmlConflictDelRangeEnd>
InsertedRun <w:ins>
DeletedRun <w:del>
MoveFromRun <w:moveFrom>
MoveToRun <w:moveTo>
ContentPart <w:contentPart>
DocumentFormat.OpenXml.Office2010.Word.RunConflictInsertion <w14:conflictIns>
DocumentFormat.OpenXml.Office2010.Word.RunConflictDeletion <w14:conflictDel>

[ISO/IEC 29500-1 1st Edition]

17.10.3 ftr (Footer)

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

Within the ftr 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 footer:

DocumentFormat.OpenXml.Wordprocessing.Footer-image

This document defines one footer with the text footer. The footer contents are stored in a unique footer part. The resulting footer is represented by the following WordprocessingML:

<w:ftr>
<w:p>
<w:r>
<w:t>Footer</w:t>
</w:r>
</w:p>
</w:ftr>

Since footers 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 footers defined:

DocumentFormat.OpenXml.Wordprocessing.Footer-image

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

First page footer part:

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

Even page footer part:

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

Odd page footer part:

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

end example]

Parent Elements
Root element of WordprocessingML Footer 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]

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.

Footer Class

Inheritance Hierarchy

Syntax

Remarks

Thread Safety

See Also

Reference

Additional resources