addFootnote

addFootnote

BASIC / ADVANCED / PREMIUM

Inserts a footnote into the Word document.

Description
public void addFootnote(OptionsFootnote options) throws Exception

This method allows the insertion of a footnote into the Word document.

Parameters

options

Option Type Description
textDocument String Text that will appear in the Word document.
textFootnote WordFragment WordFragment that will appear as the footnote in the Word document.
footnoteMark HashMap<String, String>
  • customMark: a special character, if any, that you would like to use for the call to the footnote content.
  • font: the font family you wish to use (Arial, Calibri...).
  • bold: bold text.
  • bidi: bidi option.
  • italic: turn on italics.
  • color: an hexadecimal color ("000000", "FF0000"...).
  • rtl: right to left language.
  • highlightColor: black, blue, cyan, green, magenta, red, yellow, white, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, none.
  • underline: underlines text: single.
  • backgroundColor: an hexadecimal color.
referenceMark HashMap<String, String>
  • font: the font family you wish to use (Arial, Calibri...).
  • bold: bold text.
  • bidi: bidi option.
  • italic: turn on italics.
  • color: an hexadecimal color ('000000', 'FF0000'...).
  • rtl: right to left language.
Code samples

Example #1

The resulting Word document looks like: