FooterReference Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Footer Reference.
This class is available in Office 2007 and above.
When the object is serialized out as xml, it's qualified name is w:footerReference.
public class FooterReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(23, "footerReference")]
public class FooterReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.SchemaAttr(23, "footerReference")]
public class FooterReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.SchemaAttr("w:footerReference")]
public class FooterReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class FooterReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceTypetype FooterReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(23, "footerReference")>]
type FooterReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.SchemaAttr(23, "footerReference")>]
type FooterReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.SchemaAttr("w:footerReference")>]
type FooterReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type FooterReference = class
inherit HeaderFooterReferenceTypePublic Class FooterReference
Inherits HeaderFooterReferenceType- Inheritance
- Inheritance
- Attributes
Remarks
[ISO/IEC 29500-1 1st Edition]
footerReference (Footer Reference)
This element specifies a single footer which shall be associated with the current section in the document. This footer shall be referenced via the id attribute, which specifies an explicit relationship to the appropriate Footer part in the WordprocessingML package.
If the relationship type of the relationship specified by this element is not http://schemas.openxmlformats.org/officeDocument/2006/footer, is not present, or does not have a TargetMode attribute value of Internal, then the document shall be considered non-conformant.
Within each section of a document there can be up to three different types of footers:
First page footer
Odd page footer
Even page footer
The footer type specified by the current footerReference is specified via the type attribute.
If any type of footer is omitted for a given section, then the following rules shall apply.
If no footerReference for the first page footer is specified and the titlePg element is specified, then the first page footer shall be inherited from the previous section or, if this is the first section in the document, a new blank footer shall be created. If the titlePg element is not specified, then no first page footer shall be shown, and the odd page footer shall be used in its place.
If no footerReference for the even page footer is specified and the evenAndOddHeaders element is specified, then the even page footer shall be inherited from the previous section or, if this is the first section in the document, a new blank footer shall be created. If the evenAndOddHeaders element is not specified, then no even page footer shall be shown. and the odd page footer shall be used in its place.
If no footerReference for the odd page footer is specified then the even page footer shall be inherited from the previous section or, if this is the first section in the document, a new blank footer shall be created.
[Example: Consider a three page document with different first, odd, and even page footers defined as follows:
d26540e8-fb44-4ee6-8bee-8814bc9aa32c
This document defines three footers, each of have a relationship from the document part with a unique relationship ID, as shown in the following packaging markup:
<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
…
<Relationship Id="rId6" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" Target="footer1.xml" />
<Relationship Id="rId7" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" Target="footer2.xml" />
<Relationship Id="rId10" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer" Target="footer3.xml" />
…
</Relationships>
These relationships are then referenced in the section's properties using the following WordprocessingML:
<w:sectPr>
…
<w:footerReference r:id="rId6" w:type="first" />
<w:footerReference r:id="rId7" w:type="default" />
<w:footerReference r:id="rId10" w:type="even" />
…
</w:sectPr>
The resulting section must use the footer part with relationship id rId6 for the first page, the footer part with relationship id rId10 for all subsequent even pages, and the footer part with relationship id rId7 for all subsequent odd pages. end example]
| Parent Elements |
|---|
| sectPr (§17.6.17); sectPr (§17.6.18) |
[Note: The W3C XML Schema definition of this element’s content model (CT_HdrFtrRef) is located in §A.1. end note]
� ISO/IEC29500: 2008.
Constructors
| FooterReference() |
Initializes a new instance of the FooterReference class. |
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 OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| 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 OpenXmlLeafElement) |
| Id |
Relationship to Part Represents the following attribute in the schema: r:id (Inherited from HeaderFooterReferenceType) |
| InnerText |
Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement) |
| InnerXml |
Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement) |
| LastChild |
Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement) |
| LocalName | |
| 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) |
| 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) |
| Type |
type Represents the following attribute in the schema: w:type (Inherited from HeaderFooterReferenceType) |
| 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) |
| 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 OpenXmlElement) |
| 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 OpenXmlElement) |
| 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 in the current element's list of child elements. (Inherited from OpenXmlElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement) |
| 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) |
| 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 elements. (Inherited from OpenXmlElement) |
| 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) |
| Remove() |
Removes the current element from its parent. (Inherited from OpenXmlElement) |
| RemoveAllChildren() |
Removes all child elements of the current element. (Inherited from OpenXmlLeafElement) |
| 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 from the current element's list of child elements. (Inherited from OpenXmlElement) |
| 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 a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement) |
| 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 OpenXmlElement) |
Explicit Interface Implementations
| IEnumerable.GetEnumerator() | (Inherited from OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement) |