Footnote

Overview

Footnote is a class in Aspose.Words FOSS for Java. Inherits from: InlineStory, ITrackableNode.

Represents a container for text of a footnote or endnote.

Edition status of its 38 listed members (a property and its accessor methods are listed separately, overloads once): 38 not yet exercised by a verified example.

This class declares 23 methods for Footnote objects in Java programs. Available methods include: Footnote, accept, acceptEnd, acceptStart, ensureMinimum, getActualReferenceMark, getFirstParagraph, getFont, getFootnoteType, getLastParagraph, getNodeType, getParagraphs, and 10 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: actualReferenceMark, auto, deleteRevision, firstParagraph, font, footnoteType, and 10 more.

Properties

NameTypeAccessDescription
nodeTypeintReadReturns Footnote.
storyTypeintReadReturns StoryType.FOOTNOTES or StoryType.ENDNOTES.
footnoteTypeintReadReturns a value that specifies whether this is a footnote or endnote.
autobooleanRead/WriteHolds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
referenceMarkStringRead/WriteGets/sets custom reference mark to be used for this footnote.
actualReferenceMarkStringReadGets the actual text of the reference mark displayed in the document for this footnote.
parentParagraphParagraphReadRetrieves the parent Paragraph of this node.
firstParagraphParagraphReadGets the first paragraph in the story.
lastParagraphParagraphReadGets the last paragraph in the story.
paragraphsParagraphCollectionReadGets a collection of paragraphs that are immediate children of the story.
tablesTableCollectionReadGets a collection of tables that are immediate children of the story.
insertRevisionbooleanReadGets the insert revision.
deleteRevisionbooleanReadGets the delete revision.
moveFromRevisionbooleanReadGets the move from revision.
moveToRevisionbooleanReadGets the move to revision.
fontFontReadProvides access to the font formatting of the anchor character of this object.

Methods

SignatureDescription
Footnote(doc: DocumentBase, footnoteType: int)Initializes an instance of the Footnote class.
getNodeType() → intReturns Footnote.
getStoryType() → intReturns StoryType.FOOTNOTES or StoryType.ENDNOTES.
getFootnoteType() → intReturns a value that specifies whether this is a footnote or endnote.
isAuto() → booleanHolds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark.
isAuto(value: boolean)Calls isAuto(value) on this Footnote instance.
getReferenceMark() → StringGets/sets custom reference mark to be used for this footnote.
setReferenceMark(value: String)Sets the reference mark value.
getActualReferenceMark() → StringGets the actual text of the reference mark displayed in the document for this footnote.
accept(visitor: DocumentVisitor) → booleanCalls accept(visitor) on this Footnote instance.
acceptStart(visitor: DocumentVisitor) → intAccepts a visitor for visiting the start of the footnote.
acceptEnd(visitor: DocumentVisitor) → intAccepts a visitor for visiting the end of the footnote.
getParentParagraph() → ParagraphRetrieves the parent Paragraph of this node.
getFirstParagraph() → ParagraphGets the first paragraph in the story.
getLastParagraph() → ParagraphGets the last paragraph in the story.
getParagraphs() → ParagraphCollectionGets a collection of paragraphs that are immediate children of the story.
getTables() → TableCollectionGets a collection of tables that are immediate children of the story.
isInsertRevision() → booleanReturns true if insert revision is set.
isDeleteRevision() → booleanReturns true if delete revision is set.
isMoveFromRevision() → booleanReturns true if move from revision is set.
isMoveToRevision() → booleanReturns true if move to revision is set.
getFont() → FontProvides access to the font formatting of the anchor character of this object.
ensureMinimum()If the last child is not a paragraph, creates and appends one empty paragraph.

See Also