com.aspose.words

Class FootnoteNumberingRule

  • java.lang.Object
    • com.aspose.words.FootnoteNumberingRule
public class FootnoteNumberingRule 
extends java.lang.Object

Utility class containing constants. Determines when automatic footnote or endnote numbering restarts.

Example:

Shows how to insert footnotes and edit their appearance.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert 3 paragraphs with a footnote at the end of each one
builder.write("Text 1. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write("Text 2. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 2");
builder.write("Text 3. ");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote 3", "Custom reference mark");

// Edit the numbering and positioning of footnotes 
doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT);
doc.getFootnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN);
doc.getFootnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS);
doc.getFootnoteOptions().setStartNumber(1);

doc.save(getArtifactsDir() + "Document.Footnotes.docx");
See Also:
FootnoteOptions, EndnoteOptions

Field Summary
static final intCONTINUOUS = 0
Numbering continuous throughout the document.
static final intRESTART_SECTION = 1
Numbering restarts at each section.
static final intRESTART_PAGE = 2
Numbering restarts at each page. Valid for footnotes only.
static final intDEFAULT = 0
Equals CONTINUOUS.
 

    • Field Detail

      • CONTINUOUS = 0

        public static final int CONTINUOUS
        Numbering continuous throughout the document.
      • RESTART_SECTION = 1

        public static final int RESTART_SECTION
        Numbering restarts at each section.
      • RESTART_PAGE = 2

        public static final int RESTART_PAGE
        Numbering restarts at each page. Valid for footnotes only.
      • DEFAULT = 0

        public static final int DEFAULT
        Equals CONTINUOUS.