Working with Footnote and Endnote

Aspose.Words also provides some classes, methods and properties for working with footnotes and endnotes.

Insert Endnote and Set Numbering Options

If you want to insert a footnote or an endnote in a Word document, please use InsertFootnote method. This method inserts a footnote or endnote into the document.

EndnoteOptions and FootnoteOptions classes represent numbering options for footnote and endnote.

The following code example shows how to insert endnote into the document and set its numbering options:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "TestFile.docx");

DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Some text");

builder.insertFootnote(FootnoteType.ENDNOTE, "Endnote text.");

EndnoteOptions option = doc.getEndnoteOptions();
option.setRestartRule(FootnoteNumberingRule.RESTART_PAGE);
option.setPosition(EndnotePosition.END_OF_SECTION);

dataDir = dataDir + "TestFile_Out.doc";

// Save the document to disk.
doc.save(dataDir);

Set Number of Footnote Layout Columns

You can set the number of footnote layout columns using Columns property. If this property has the value of 0, the footnotes area is formatted with a number of columns based on the number of columns on the displayed page.

The following code example shows how to set the number of columns for footnote layout:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "TestFile.docx");

//Specify the number of columns with which the footnotes area is formatted.
doc.getFootnoteOptions().setColumns(3);
dataDir = dataDir + "TestFile_Out.doc";

// Save the document to disk.
doc.save(dataDir);

Set the Position of Footnote and EndNote

The footnote position can be at the bottom of each page or beneath the text on each page. The endnote position can be at the end of the section or at the end of the document.

The following code example shows how to set the position of footnote and endnote:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
Document doc = new Document(dataDir + "TestFile.docx");

//Set footnote and endnode position.
doc.getFootnoteOptions().setPosition(FootnotePosition.BENEATH_TEXT);
doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_SECTION);
dataDir = dataDir + "TestFile_Out.doc";

// Save the document to disk.
doc.save(dataDir);