FootnoteSpecialReference Class

Special Footnote List.When the object is serialized out as xml, its qualified name is w:footnote.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.FootnoteEndnoteSeparatorReferenceType
        DocumentFormat.OpenXml.Wordprocessing.FootnoteSpecialReference

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

Syntax

'Declaration
Public Class FootnoteSpecialReference _
    Inherits FootnoteEndnoteSeparatorReferenceType
'Usage
Dim instance As FootnoteSpecialReference
public class FootnoteSpecialReference : FootnoteEndnoteSeparatorReferenceType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.11.9 footnote (Special Footnote List)

This element specifies the ID for all footnotes which are located in the current document that are not of style normal. Each other type of footnote shall be referenced in this list, or it shall not be loaded. This means that if a special footnote is not listed beneath this element, and it is required by the document content, then the document shall be considered non-conformant.

[Example: Consider a document that has three footnotes represented by the following WordprocessingML:

<w:footnotes>
  <w:footnote w:type="separator" w:id="0">
    …
  </w:footnote>
  <w:footnote w:type="continuationSeparator" w:id="1">
    …
  </w:footnote >
  <w:footnote w:id="2">
    …
  </w:footnote>
</w:footnotes>

Each of the footnotes which are not of style normal must be specified in the footnotePr element, as follows:

<w:footnotePr>
  <w:footnote w:id="0" />
  <w:footnote w:id="1" />
</w:footnotePr>

This indicates to the consumer that the footnotes with an id attribute value of 0 and 1 are special footnotes, and should be treated accordingly. end example]

Parent Elements

footnotePr (§17.11.12)

Attributes

Description

id (Footnote/Endnote ID)

Specifies a unique ID which shall be used to match the contents of a footnote or endnote to the associated footnote/endnote reference mark in the document using the footnoteRef or endnoteRef element, as appropriate.

If more than one footnote shares the same ID, then this document shall be considered non-conformant. If more than one endnote shares the same ID, then this document shall be considered non-conformant.

[Example: Consider the following footnote as defined in the footnotes part:

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

The contents of this footnote are associated with the footnoteReference with a matching ID, as follows:

<w:p>
<w:r>
<w:footnoteReference w:id="0" />
</w:r>
</w:p>

The resulting paragraph has a footnote reference mark which references the footnote number value of the footnote with an id of 0. 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_FtnEdnSepRef) 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

FootnoteSpecialReference Members

DocumentFormat.OpenXml.Wordprocessing Namespace