addFootnote

addFootnote

BASIC / ADVANCED / PREMIUM

Inserts a footnote into the Word document.

Description
public addFootnote ( array $options )

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

You may fully customize the footnote content including all kind of elements like paragraphs of text with sophisticated formatting, images, links or even tables and HTML content.

If one wishes to insert a footnote within a complex paragraph one should use this method in combination with the addText method.

Parameters

options

An array with the available options.

The possible keys and values are (required options are shown with red background):

key Type Description
textDocument mixed This can be a string of text that will appear in the Word document just before the footnote call or an array with the text and the formatting options (as in the addText method) or a Word fragment.
textFootnote mixed This is a string of text that will show up in the corresponding footnote or a Word fragment that may include a variety of elements.
footnoteMark array The keys of this array are:
  • 'customMark': a special character, if any, that we would like to use for the call to the footnote content,
  • 'font' : the font family we wish to use (Arial, Calibri, ...,)
  • 'bold': true or false for bold text,
  • 'bidi': true for right to left languages,
  • 'italic': true or false to turn on italics,
  • 'color': an hexadecimal color ('000000', 'FF0000', ...),
  • 'rtl': true for right to left languages.
referenceMark array The keys of this array are:
  • 'font': the font family we wish to use (Arial, Calibri, ...,)
  • 'bold': true or false for bold text,
  • 'bidi': true for right to left languages,
  • 'italic': true or false to turn on italics,
  • 'color': an hexadecimal color ('000000', 'FF0000', ...),
  • 'rtl': true for right to left languages.
Return values

Void.

Code samples

Example #1

The resulting Word document looks like:

Example #2

The resulting Word document looks like: