JSON API - addEndnote

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addEndnote

PREMIUM

TRIAL / ADVANCED

Inserts an endnote.

Note

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

JSON data

{
    "textDocument": "string" | array,
    "textEndnote": "string",
    "textEndnotes": array,
    "pStyle": "string",
    "rStyle": "string",
    "endnoteMark": {
        "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.
textEndnote	string or WordFragment.
textEndnotes	Add multiple endnotes.
pStyle	Paragraph style. Default as endnoteTextPHPDOCX.
rStyle	Character style. Default as endnoteReferencePHPDOCX.
endnoteMark	"customMark": a special character, if any, that you would like to use for the call to the endnote 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_endnote",
            "actions": [
                {
                    "action": "addEndnote",
                    "data": {
                        "textDocument": "endnote",
                        "textEndnote": "The endnote we want to insert."
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "Here comes the " },
                    { "text": "wf_endnote" },
                    { "text": " and some other text." }
                ]
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Some other text."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.