FootnotePosition Class

Footnote Placement.When the object is serialized out as xml, its qualified name is w:pos.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.FootnotePosition

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

Syntax

'Declaration
Public Class FootnotePosition _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As FootnotePosition
public class FootnotePosition : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.11.21 pos (Footnote Placement)

This element specifies where footnotes shall be placed on the page when they are referenced by text in the current document.

If this element is present at the section level, then it shall be ignored.

If this element is omitted at the document level, then footnotes shall be located at the bottom of the current page.

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

DocumentFormat.OpenXml.Wordprocessing.FootnotePosi

The footnote references the text reading Some reference text. and is represented by the following WordprocessingML:

<w:p>
<w:r>
<w:t>Some referenced text</w:t>
</w:r>
<w:r>
<w:rPr>
<w:rStyle w:val="FootnoteReference" />
</w:rPr>
<w:footnoteReference w:id="2" />
</w:r>
</w:p>

Since the footnote location must be beneath the current text, the section properties must be declared as follows:

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

The footnote references the footnote in the footnotes part with an id attribute value equal to 2. Within the section properties of the document, the position of footnotes is specified to be beneath the page's text. end example]

Parent Elements

footnotePr (§17.11.12); footnotePr (§17.11.11)

Attributes

Description

val (Footnote Position Type)

Specifies the position of footnotes in the document.

[Example: Consider a document in which footnotes must be positioned beneath their text. The footnote properties for this document must be declared as follows:

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

The val attribute is beneathText, therefore the position of footnotes is specified to be beneath the page's text. end example]

The possible values for this attribute are defined by the ST_FtnPos simple type (§17.18.34).

[Note: The W3C XML Schema definition of this element’s content model (CT_FtnPos) 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

FootnotePosition Members

DocumentFormat.OpenXml.Wordprocessing Namespace