FootnoteDocumentWideProperties Class

Document-Wide Footnote Properties.When the object is serialized out as xml, its qualified name is w:footnotePr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.FootnoteDocumentWideProperties

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(FootnotePosition))> _
<ChildElementInfoAttribute(GetType(NumberingStart))> _
<ChildElementInfoAttribute(GetType(FootnoteSpecialReference))> _
<ChildElementInfoAttribute(GetType(NumberingFormat))> _
<ChildElementInfoAttribute(GetType(NumberingRestart))> _
Public Class FootnoteDocumentWideProperties _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As FootnoteDocumentWideProperties

[ChildElementInfoAttribute(typeof(FootnotePosition))]
[ChildElementInfoAttribute(typeof(NumberingStart))]
[ChildElementInfoAttribute(typeof(FootnoteSpecialReference))]
[ChildElementInfoAttribute(typeof(NumberingFormat))]
[ChildElementInfoAttribute(typeof(NumberingRestart))]
public class FootnoteDocumentWideProperties : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• FootnotePosition <w:pos>

• NumberingFormat <w:numFmt>

• NumberingStart <w:numStart>

• NumberingRestart <w:numRestart>

• FootnoteSpecialReference <w:footnote>

[ISO/IEC 29500-1 1st Edition]

17.11.12 footnotePr (Document-Wide Footnote Properties)

This element specifies the footnote properties for this document. Each property is stored as a unique element within the footnotePr element.

These properties can be overridden for a specific section via the section-wide footnotePr element (§17.11.11).

[Example: Consider the following one page document, where the footnote appears beneath the text it references:

Since the document consists of a single footnote, the footnote properties can be stored in either the section-wide or document-wide footnote properties. Assuming that they are stored in the latter, the footnote properties are represented by the following WordprocessingML:

<w:settings>
  …
  <w:footnotePr>
    <w:pos w:val="beneathText" />
  </w:footnotePr>
  …
</w:settings>

The footnote properties specify that footnotes appear below the noted text end example]

Parent Elements
settings (§17.15.1.78)

Child Elements	Subclause
footnote (Special Footnote List)	§17.11.9
numFmt (Footnote Numbering Format)	§17.11.18
numRestart (Footnote and Endnote Numbering Restart Location)	§17.11.19
numStart (Footnote and Endnote Numbering Starting Value)	§17.11.20
pos (Footnote Placement)	§17.11.21

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

© ISO/IEC29500: 2008.

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.

See Also

Reference

FootnoteDocumentWideProperties Members

DocumentFormat.OpenXml.Wordprocessing Namespace