JSON API - addFootnote

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addFootnote

PREMIUM

TRIAL / ADVANCED

Inserts a footnote.

Note

You are reading the JSON API documentation. For the PHP API method please go to addFootnote.

JSON data

{
    "textDocument": "string" | array,
    "textFootnote": "string",
    "textFootnotes": array,
    "pStyle": "string",
    "rStyle": "string",
    "footnoteMark": {
        "customMark": "string",
        "font": "string",
        "fontSize": number,
        "bold": boolean,
        "bidi": boolean,
        "italic": boolean,
        "color": "string",
        "rtl": boolean,
        "highlightColor": "string",
        "underline": "string",
        "backgroundColor": "string"
    },
    "referenceMark": {
        "font": "string",
        "fontSize": number,
        "bold": boolean,
        "bidi": boolean,
        "italic": boolean,
        "color": "string",
        "rtl": boolean,
        "highlightColor": "string",
        "underline": "string",
        "backgroundColor": "string"
    }
}

Other styles from createParagraphStyle can be used.

Key	Description
textDocument	string or WordFragment.
textFootnote	string or WordFragment.
textFootnotes	Add multiple footnotes.
pStyle	Paragraph style. Default as footnoteTextPHPDOCX.
rStyle	Character style. Default as footnoteReferencePHPDOCX.
footnoteMark	"customMark": a special character, if any, that you would like to use for the call to the footnote content. "font": font family (Arial, Calibri...). "fontSize": the font size. "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. "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	"font": font family (Arial, Calibri...). "fontSize": the font size. "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. "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.

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_footnote",
            "actions": [
                {
                    "action": "addFootnote",
                    "data": {
                        "textDocument": "footnote",
                        "textFootnote": "The footnote we want to insert."
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "Here comes the " },
                    { "text": "wf_footnote" },
                    { "text": " and some other text." }
                ]
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Some other text."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.