JSON API - addFooter

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addFooter

PREMIUM

TRIAL / ADVANCED

Inserts footers into a Word document.

Note

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

The contents of the different footers are defined via the use of WordFragments.

JSON data

{
    "default": "string",
    "even": "string",
    "first": "string"
}

Key	Description
default	The WordFragment containing the contents for the default (odd pages) footer.
even	The WordFragment containing the contents for the even pages footer.
first	The WordFragment containing the contents for the first (title) page footer.

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_image",
            "target": "defaultFooter",
            "actions": [
                {
                    "action": "addImage",
                    "data": {
                        "src": "image.png",
                        "dpi": 300
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addFooter",
            "data": {
                "default": "wf_image"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This document has a footer with just one image."
            }
        }
    ]
}

Example #2

{
    "wordfragments": [
        {
            "name": "wf_image",
            "target": "defaultFooter",
            "actions": [
                {
                    "action": "addImage",
                    "data": {
                        "src": "image.png",
                        "dpi": 300
                    }
                }
            ]
        },
        {
            "name": "wf_text_first_footer",
            "target": "firstFooter",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "first page footer."
                    }
                }
            ]
        },
        {
            "name": "wf_text_even_footer",
            "target": "evenFooter",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "even page footer."
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addFooter",
            "data": {
                "default": "wf_image",
                "first": "wf_text_first_footer",
                "even": "wf_text_even_footer"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the first page of a document with different footers for the first and even pages."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the second page."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the third page."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.