Footnote class

Footnote class

Represents a container for text of a footnote or endnote. To learn more, visit the Working with Footnote and Endnote documentation article.

Remarks

The Footnote class is used to represent both footnotes and endnotes in a Word document.

Footnote is an inline-level node and can only be a child of Paragraph.

Footnote can contain Paragraph and Table child nodes.

Inheritance: FootnoteInlineStoryCompositeNodeNode

Constructors

NameDescription
Footnote(doc, footnoteType)Initializes an instance of the Footnote class.

Properties

NameDescription
actualReferenceMarkGets the actual text of the reference mark displayed in the document for this footnote.
countGets the number of immediate children of this node.
(Inherited from CompositeNode)
customNodeIdSpecifies custom node identifier.
(Inherited from Node)
documentGets the document to which this node belongs.
(Inherited from Node)
firstChildGets the first child of the node.
(Inherited from CompositeNode)
firstParagraphGets the first paragraph in the story.
(Inherited from InlineStory)
fontProvides access to the font formatting of the anchor character of this object.
(Inherited from InlineStory)
footnoteTypeReturns a value that specifies whether this is a footnote or endnote.
hasChildNodesReturns true if this node has any child nodes.
(Inherited from CompositeNode)
isAutoHolds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
isCompositeReturns true if this node can contain other nodes.
(Inherited from Node)
isDeleteRevisionReturns true if this object was deleted in Microsoft Word while change tracking was enabled.
(Inherited from InlineStory)
isInsertRevisionReturns true if this object was inserted in Microsoft Word while change tracking was enabled.
(Inherited from InlineStory)
isMoveFromRevisionReturns true if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
(Inherited from InlineStory)
isMoveToRevisionReturns true if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
(Inherited from InlineStory)
lastChildGets the last child of the node.
(Inherited from CompositeNode)
lastParagraphGets the last paragraph in the story.
(Inherited from InlineStory)
nextSiblingGets the node immediately following this node.
(Inherited from Node)
nodeTypeReturns NodeType.Footnote.
paragraphsGets a collection of paragraphs that are immediate children of the story.
(Inherited from InlineStory)
parentNodeGets the immediate parent of this node.
(Inherited from Node)
parentParagraphRetrieves the parent Paragraph of this node.
(Inherited from InlineStory)
previousSiblingGets the node immediately preceding this node.
(Inherited from Node)
rangeReturns a Range object that represents the portion of a document that is contained in this node.
(Inherited from Node)
referenceMarkGets/sets custom reference mark to be used for this footnote. Default value is empty string (), meaning auto-numbered footnotes are used.
storyTypeReturns StoryType.Footnotes or StoryType.Endnotes.
tablesGets a collection of tables that are immediate children of the story.
(Inherited from InlineStory)

Methods

NameDescription
accept(visitor)Accepts a visitor.
acceptEnd(visitor)Accepts a visitor for visiting the end of the footnote.
acceptStart(visitor)Accepts a visitor for visiting the start of the footnote.
appendChild(newChild)Adds the specified node to the end of the list of child nodes for this node.
(Inherited from CompositeNode)
asBody()Cast node to Body.
(Inherited from Node)
asBookmarkEnd()Cast node to BookmarkEnd.
(Inherited from Node)
asBookmarkStart()Cast node to BookmarkStart.
(Inherited from Node)
asBuildingBlock()Cast node to BuildingBlock.
(Inherited from Node)
asCell()Cast node to Cell.
(Inherited from Node)
asComment()Cast node to Comment.
(Inherited from Node)
asCommentRangeEnd()Cast node to CommentRangeEnd.
(Inherited from Node)
asCommentRangeStart()Cast node to CommentRangeStart.
(Inherited from Node)
asCompositeNode()Cast node to CompositeNode.
(Inherited from Node)
asDocument()Cast node to Node.document.
(Inherited from Node)
asEditableRangeEnd()Cast node to EditableRangeEnd.
(Inherited from Node)
asEditableRangeStart()Cast node to EditableRangeStart.
(Inherited from Node)
asFieldEnd()Cast node to FieldEnd.
(Inherited from Node)
asFieldSeparator()Cast node to FieldSeparator.
(Inherited from Node)
asFieldStart()Cast node to FieldStart.
(Inherited from Node)
asFootnote()Cast node to Footnote.
(Inherited from Node)
asFormField()Cast node to FormField.
(Inherited from Node)
asGlossaryDocument()Cast node to GlossaryDocument.
(Inherited from Node)
asGroupShape()Cast node to GroupShape.
(Inherited from Node)
asHeaderFooter()Cast node to HeaderFooter.
(Inherited from Node)
asOfficeMath()Cast node to OfficeMath.
(Inherited from Node)
asParagraph()Cast node to Paragraph.
(Inherited from Node)
asRow()Cast node to Row.
(Inherited from Node)
asRun()Cast node to Run.
(Inherited from Node)
asSection()Cast node to Section.
(Inherited from Node)
asShape()Cast node to Shape.
(Inherited from Node)
asSmartTag()Cast node to SmartTag.
(Inherited from Node)
asSpecialChar()Cast node to SpecialChar.
(Inherited from Node)
asStructuredDocumentTag()Cast node to StructuredDocumentTag.
(Inherited from Node)
asStructuredDocumentTagRangeEnd()Cast node to StructuredDocumentTagRangeEnd.
(Inherited from Node)
asStructuredDocumentTagRangeStart()Cast node to StructuredDocumentTagRangeStart.
(Inherited from Node)
asSubDocument()Cast node to SubDocument.
(Inherited from Node)
asTable()Cast node to Table.
(Inherited from Node)
clone(isCloneChildren)Creates a duplicate of the node.
(Inherited from Node)
ensureMinimum()If the last child is not a paragraph, creates and appends one empty paragraph.
(Inherited from InlineStory)
getAncestor(ancestorType)Gets the first ancestor of the specified NodeType.
(Inherited from Node)
getBuildingBlock(index, isDeep)
(Inherited from CompositeNode)
getChild(nodeType, index, isDeep)Returns an Nth child node that matches the specified type.
(Inherited from CompositeNode)
getChildNodes(nodeType, isDeep)Returns a live collection of child nodes that match the specified type.
(Inherited from CompositeNode)
getComment(index, isDeep)
(Inherited from CompositeNode)
getEditableRangeStart(index, isDeep)
(Inherited from CompositeNode)
getFootnote(index, isDeep)
(Inherited from CompositeNode)
getGroupShape(index, isDeep)
(Inherited from CompositeNode)
getOfficeMath(index, isDeep)
(Inherited from CompositeNode)
getParagraph(index, isDeep)
(Inherited from CompositeNode)
getRun(index, isDeep)
(Inherited from CompositeNode)
getSdt(index, isDeep)
(Inherited from CompositeNode)
getSdtRangeEnd(index, isDeep)
(Inherited from CompositeNode)
getSdtRangeStart(index, isDeep)
(Inherited from CompositeNode)
getShape(index, isDeep)
(Inherited from CompositeNode)
getSmartTag(index, isDeep)
(Inherited from CompositeNode)
getTable(index, isDeep)
(Inherited from CompositeNode)
getText()Gets the text of this node and of all its children.
(Inherited from Node)
indexOf(child)Returns the index of the specified child node in the child node array.
(Inherited from CompositeNode)
insertAfter(newChild, refChild)Inserts the specified node immediately after the specified reference node.
(Inherited from CompositeNode)
insertBefore(newChild, refChild)Inserts the specified node immediately before the specified reference node.
(Inherited from CompositeNode)
nextPreOrder(rootNode)Gets next node according to the pre-order tree traversal algorithm.
(Inherited from Node)
nodeTypeToString(nodeType)A utility method that converts a node type enum value into a user friendly string.
(Inherited from Node)
prependChild(newChild)Adds the specified node to the beginning of the list of child nodes for this node.
(Inherited from CompositeNode)
previousPreOrder(rootNode)Gets the previous node according to the pre-order tree traversal algorithm.
(Inherited from Node)
referenceEquals(other)
(Inherited from Node)
remove()Removes itself from the parent.
(Inherited from Node)
removeAllChildren()Removes all the child nodes of the current node.
(Inherited from CompositeNode)
removeChild(oldChild)Removes the specified child node.
(Inherited from CompositeNode)
removeSmartTags()Removes all SmartTag descendant nodes of the current node.
(Inherited from CompositeNode)
selectNodes(xpath)Selects a list of nodes matching the XPath expression.
(Inherited from CompositeNode)
selectSingleNode(xpath)Selects the first Node that matches the XPath expression.
(Inherited from CompositeNode)
toString(saveFormat)Exports the content of the node into a string in the specified format.
(Inherited from Node)
toString(saveOptions)Exports the content of the node into a string using the specified save options.
(Inherited from Node)

Examples

Shows how to insert and customize footnotes.

let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);

// Add text, and reference it with a footnote. This footnote will place a small superscript reference
// mark after the text that it references and create an entry below the main body text at the bottom of the page.
// This entry will contain the footnote's reference mark and the reference text,
// which we will pass to the document builder's "InsertFootnote" method.
builder.write("Main body text.");
let footnote = builder.insertFootnote(aw.Notes.FootnoteType.Footnote, "Footnote text.");

// If this property is set to "true", then our footnote's reference mark
// will be its index among all the section's footnotes.
// This is the first footnote, so the reference mark will be "1".
expect(footnote.isAuto).toEqual(true);

// We can move the document builder inside the footnote to edit its reference text. 
builder.moveTo(footnote.firstParagraph);
builder.write(" More text added by a DocumentBuilder.");
builder.moveToDocumentEnd();

expect(footnote.getText().trim()).toEqual("\u0002 Footnote text. More text added by a DocumentBuilder.");

builder.write(" More main body text.");
footnote = builder.insertFootnote(aw.Notes.FootnoteType.Footnote, "Footnote text.");

// We can set a custom reference mark which the footnote will use instead of its index number.
footnote.referenceMark = "RefMark";

expect(footnote.isAuto).toEqual(false);

// A bookmark with the "IsAuto" flag set to true will still show its real index
// even if previous bookmarks display custom reference marks, so this bookmark's reference mark will be a "3".
builder.write(" More main body text.");
footnote = builder.insertFootnote(aw.Notes.FootnoteType.Footnote, "Footnote text.");

expect(footnote.isAuto).toEqual(true);

doc.save(base.artifactsDir + "InlineStory.AddFootnote.docx");

See Also