Footnote Class
Footnote Content.When the object is serialized out as xml, its qualified name is w:footnote.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Wordprocessing.FootnoteEndnoteType
DocumentFormat.OpenXml.Wordprocessing.Footnote
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class Footnote _
Inherits FootnoteEndnoteType
'Usage
Dim instance As Footnote
public class Footnote : FootnoteEndnoteType
Remarks
The following table lists the possible child types:
AltChunk <w:altChunk>
CustomXmlBlock <w:customXml>
SdtBlock <w:sdt>
Paragraph <w:p>
Table <w:tbl>
ProofError <w:proofErr>
PermStart <w:permStart>
PermEnd <w:permEnd>
BookmarkStart <w:bookmarkStart>
BookmarkEnd <w:bookmarkEnd>
CommentRangeStart <w:commentRangeStart>
CommentRangeEnd <w:commentRangeEnd>
MoveFromRangeStart <w:moveFromRangeStart>
MoveFromRangeEnd <w:moveFromRangeEnd>
MoveToRangeStart <w:moveToRangeStart>
MoveToRangeEnd <w:moveToRangeEnd>
CustomXmlInsRangeStart <w:customXmlInsRangeStart>
CustomXmlInsRangeEnd <w:customXmlInsRangeEnd>
CustomXmlDelRangeStart <w:customXmlDelRangeStart>
CustomXmlDelRangeEnd <w:customXmlDelRangeEnd>
CustomXmlMoveFromRangeStart <w:customXmlMoveFromRangeStart>
CustomXmlMoveFromRangeEnd <w:customXmlMoveFromRangeEnd>
CustomXmlMoveToRangeStart <w:customXmlMoveToRangeStart>
CustomXmlMoveToRangeEnd <w:customXmlMoveToRangeEnd>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictInsertionRangeStart <w14:customXmlConflictInsRangeStart>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictInsertionRangeEnd <w14:customXmlConflictInsRangeEnd>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictDeletionRangeStart <w14:customXmlConflictDelRangeStart>
DocumentFormat.OpenXml.Office2010.Word.CustomXmlConflictDeletionRangeEnd <w14:customXmlConflictDelRangeEnd>
InsertedRun <w:ins>
DeletedRun <w:del>
MoveFromRun <w:moveFrom>
MoveToRun <w:moveTo>
ContentPart <w:contentPart>
DocumentFormat.OpenXml.Office2010.Word.RunConflictInsertion <w14:conflictIns>
DocumentFormat.OpenXml.Office2010.Word.RunConflictDeletion <w14:conflictDel>
[ISO/IEC 29500-1 1st Edition]
17.11.10 footnote (Footnote Content)
This element specifies the content of a single footnote within a WordprocessingML document. Each footnote shall be represented by a single footnote element, which can contain any block-level content.
[Example: Consider a document with a single footnote, identified by a footnote element, defined in the footnotes part as follows:
<w:footnotes> <w:footnote w:id="2"> <w:p> <w:pPr> <w:pStyle w:val="FootnoteText" /> </w:pPr> <w:r> <w:rPr> <w:rStyle w:val="FootnoteReference" /> </w:rPr> <w:footnoteRef /> </w:r> <w:r> <w:t xml:space="preserve">This is a sample footnote</w:t> </w:r> </w:p> </w:footnote> </w:footnotes>
This footnote contains an footnote reference mark, as well as the endnote text This is a sample footnote. end example]
Parent Elements |
|---|
footnotes (§17.11.15) |
Child Elements |
Subclause |
|---|---|
altChunk (Anchor for Imported External Content) |
§17.17.2.1 |
bookmarkEnd (Bookmark End) |
§17.13.6.1 |
bookmarkStart (Bookmark Start) |
§17.13.6.2 |
commentRangeEnd (Comment Anchor Range End) |
§17.13.4.3 |
commentRangeStart (Comment Anchor Range Start) |
§17.13.4.4 |
customXml (Block-Level Custom XML Element) |
§17.5.1.6 |
customXmlDelRangeEnd (Custom XML Markup Deletion End) |
§17.13.5.4 |
customXmlDelRangeStart (Custom XML Markup Deletion Start) |
§17.13.5.5 |
customXmlInsRangeEnd (Custom XML Markup Insertion End) |
§17.13.5.6 |
customXmlInsRangeStart (Custom XML Markup Insertion Start) |
§17.13.5.7 |
customXmlMoveFromRangeEnd (Custom XML Markup Move Source End) |
§17.13.5.8 |
customXmlMoveFromRangeStart (Custom XML Markup Move Source Start) |
§17.13.5.9 |
customXmlMoveToRangeEnd (Custom XML Markup Move Destination Location End) |
§17.13.5.10 |
customXmlMoveToRangeStart (Custom XML Markup Move Destination Location Start) |
§17.13.5.11 |
del (Deleted Run Content) |
§17.13.5.14 |
ins (Inserted Run Content) |
§17.13.5.18 |
moveFrom (Move Source Run Content) |
§17.13.5.22 |
moveFromRangeEnd (Move Source Location Container - End) |
§17.13.5.23 |
moveFromRangeStart (Move Source Location Container - Start) |
§17.13.5.24 |
moveTo (Move Destination Run Content) |
§17.13.5.25 |
moveToRangeEnd (Move Destination Location Container - End) |
§17.13.5.27 |
moveToRangeStart (Move Destination Location Container - Start) |
§17.13.5.28 |
oMath (Office Math) |
§22.1.2.77 |
oMathPara (Office Math Paragraph) |
§22.1.2.78 |
p (Paragraph) |
§17.3.1.22 |
permEnd (Range Permission End) |
§17.13.7.1 |
permStart (Range Permission Start) |
§17.13.7.2 |
proofErr (Proofing Error Anchor) |
§17.13.8.1 |
sdt (Block-Level Structured Document Tag) |
§17.5.2.29 |
tbl (Table) |
§17.4.38 |
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 this attribute is omitted, then this footnote or endnote shall have no ID. 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). |
type (Footnote/Endnote Type) |
Specifies the type of footnote or endnote contained within the current footnote or endnote content definition. If this attribute is omitted, then it shall be considered to be of style normal. If a footnote or endnote is not of style normal, then it shall not be referenced by a footnoteReference or endnoteReference element within the main document story. [Example: Consider the following example of a footnote defined in a WordprocessingML document as follows: <w:footnote w:type="continuationSeparator" w:id="1">
<w:p>
<w:r>
<w:continuationSeparator />
</w:r>
</w:p>
</w:footnote>
In this example, the footnote is of style continuationSeparator and must be used by a consumer to separate continued footnotes from the main document contents (see simple type for full details). end example] The possible values for this attribute are defined by the ST_FtnEdn simple type (§17.18.33). |
[Note: The W3C XML Schema definition of this element’s content model (CT_FtnEdn) 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.