FootnoteReference Class

  • Article

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

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.FootnoteEndnoteReferenceType
        DocumentFormat.OpenXml.Wordprocessing.FootnoteReference

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

Syntax

'Declaration
Public Class FootnoteReference _
    Inherits FootnoteEndnoteReferenceType
'Usage
Dim instance As FootnoteReference

public class FootnoteReference : FootnoteEndnoteReferenceType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.11.14 footnoteReference (Footnote Reference)

This element specifies the presence of a footnote reference. A footnote reference is a run of automatically numbered text which references a particular footnote within the parent document, and inherits the footnote reference mark's numbering.

If an footnote reference is specified within a footnote or endnote, then the document shall be considered non-conformant.

[Example: Consider the following document where some text is referenced by a footnote at the bottom of the page:

DocumentFormat.OpenXml.Wordprocessing.FootnoteRefe

The footnote reference is the superscript decimal number within the document content in the diagram above. The contents of the paragraph which contains the footnote reference are 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>

The resulting paragraph contains the literal text content of Some referenced text., followed by an automatically numbered footnote reference. Since this is the first footnote in the document, that automatically numbered reference inherits the decimal number 1 from the footnote reference mark. end example]

Parent Elements

r (§22.1.2.87); r (§17.3.2.25)

Attributes

Description

customMarkFollows (Suppress Footnote/Endnote Reference Mark)

Specifies that the current footnote or endnote shall not have an associated footnote or endnote reference mark, as appropriate.

This attribute shall be used to specify that a particular footnote or endnote shall not increment the numbering for its associated footnote/endnote numbering format, so that the use of a footnote with a custom footnote mark does not cause a missing value in the footnote/endnote values. The display of the mark is specified via the footnoteRef/endnoteRef elements, as appropriate.

If this attribute is omitted, then the footnote or endnote reference mark shall not be skipped when incrementing over this footnote or endnote.

[Example: Consider a footnote with an id value of 1 that uses a custom footnote mark:

<w:footnotes>
  <w:footnote w:id="0">
    …
  </w:footnote>
  <w:footnote w:id="2">
    …
  </w:footnote>
  <w:footnote w:id="2">
    …
  </w:footnote>
</w:footnotes>

If the numbering format for footnotes in this document is upperRoman, then the first footnote must be I, the second is suppressed, and the third is II, noticing that the second does not increment the numbering sequence. end example]

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

id (Footnote/Endnote ID Reference)

Specifies the footnote or endnote which is being referenced by the current footnote or endnote reference in the document.

If the resulting footnote or endnote ID is not present in the footnotes or endnote part (as appropriate), then this document shall be considered non-conformant.

[Example: Consider a paragraph with an endnote reference, represented by the following WordprocessingML:

<w:p>
<w:r>
<w:t>This text is followed by an endnote</w:t>
</w:r>
<w:r>
<w:endnoteReference w:id="2" />
</w:r>
<w:r>
<w:t>.</w:t>
</w:r>
</w:p>

This text references the endnote in the document's endnotes part which has an id value of 2. end example]

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

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

FootnoteReference Members

DocumentFormat.OpenXml.Wordprocessing Namespace