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
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns Footnote. |
storyType | int | Read | Returns StoryType.FOOTNOTES or StoryType.ENDNOTES. |
footnoteType | int | Read | Returns a value that specifies whether this is a footnote or endnote. |
auto | boolean | Read/Write | Holds a value that specifies whether this is a auto-numbered footnote or footnote with user defined custom reference mark. |
referenceMark | String | Read/Write | Gets/sets custom reference mark to be used for this footnote. |
actualReferenceMark | String | Read | Gets the actual text of the reference mark displayed in the document for this footnote. |
parentParagraph | Paragraph | Read | Retrieves the parent Paragraph of this node. |
firstParagraph | Paragraph | Read | Gets the first paragraph in the story. |
lastParagraph | Paragraph | Read | Gets the last paragraph in the story. |
paragraphs | ParagraphCollection | Read | Gets a collection of paragraphs that are immediate children of the story. |
tables | TableCollection | Read | Gets a collection of tables that are immediate children of the story. |
insertRevision | boolean | Read | Gets the insert revision. |
deleteRevision | boolean | Read | Gets the delete revision. |
moveFromRevision | boolean | Read | Gets the move from revision. |
moveToRevision | boolean | Read | Gets the move to revision. |
font | Font | Read | Provides access to the font formatting of the anchor character of this object. |
Methods
| Signature | Description |
|---|---|
Footnote(doc: DocumentBase, footnoteType: int) | Initializes an instance of the Footnote class. |
getNodeType() → int | Returns Footnote. |
getStoryType() → int | Returns StoryType.FOOTNOTES or StoryType.ENDNOTES. |
getFootnoteType() → int | Returns a value that specifies whether this is a footnote or endnote. |
isAuto() → boolean | Holds 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() → String | Gets/sets custom reference mark to be used for this footnote. |
setReferenceMark(value: String) | Sets the reference mark value. |
getActualReferenceMark() → String | Gets the actual text of the reference mark displayed in the document for this footnote. |
accept(visitor: DocumentVisitor) → boolean | Calls accept(visitor) on this Footnote instance. |
acceptStart(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the start of the footnote. |
acceptEnd(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the end of the footnote. |
getParentParagraph() → Paragraph | Retrieves the parent Paragraph of this node. |
getFirstParagraph() → Paragraph | Gets the first paragraph in the story. |
getLastParagraph() → Paragraph | Gets the last paragraph in the story. |
getParagraphs() → ParagraphCollection | Gets a collection of paragraphs that are immediate children of the story. |
getTables() → TableCollection | Gets a collection of tables that are immediate children of the story. |
isInsertRevision() → boolean | Returns true if insert revision is set. |
isDeleteRevision() → boolean | Returns true if delete revision is set. |
isMoveFromRevision() → boolean | Returns true if move from revision is set. |
isMoveToRevision() → boolean | Returns true if move to revision is set. |
getFont() → Font | Provides 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. |