JSON API - addFooterSection

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addFooterSection

PREMIUM

TRIAL / ADVANCED

Inserts footers in a specific section of a Word document.

Note

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

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

JSON data

{
    "default": "string",
    "even": "string",
    "first": "string"
    "section": number,
    "options": {
        "removeOthers": boolean
    }
}

Styles from addText can be used.

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.
section	Section position. -1 as default. 0 is the first section and -1 the last section.
removeOthers	If true remove other footers in the section. Default as false.

Code samples

Example #1

{
    "actions": [
        {
            "action": "createParagraphStyle",
            "data": {
                "name": "pgStyle",
                "options": {
                    "bold": true,
                    "color": "B70000",
                    "fontSize": 24
                }
            }
        },
        {
            "action": "addFooterSection",
            "wordfragments": [
                {
                    "name": "wf_text_first_section",
                    "target": "firstFooter",
                    "actions": [
                        {
                            "action": "addText",
                            "data": {
                                "text": "Footer in the first section"
                            }
                        }
                    ]
                },
                {
                    "name": "wf_image_first_section",
                    "target": "defaultFooter",
                    "actions": [
                        {
                            "action": "addImage",
                            "data": {
                                "src": "image.png",
                                "dpi": 300
                            }
                        }
                    ]
                }
            ],
            "data": {
                "first": "wf_text_first_section",
                "default": "wf_image_first_section"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This section has a footer with a text in the first footer and an image as default footer."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Second page"
            }
        },
        {
            "action": "addSection"
        },
        {
            "action": "addFooterSection",
            "wordfragments": [
                {
                    "name": "wf_text_second_section",
                    "target": "firstFooter",
                    "actions": [
                        {
                            "action": "addText",
                            "data": {
                                "text": "Footer in the second section"
                            }
                        }
                    ]
                },
                {
                    "name": "wf_content_second_section",
                    "target": "defaultFooter",
                    "actions": [
                        {
                            "action": "addImage",
                            "data": {
                                "src": "imageP1.png",
                                "dpi": 300,
                                "textWrap": 1
                            }
                        },
                        {
                            "action": "addPageNumber",
                            "data": {
                                "type": "numerical",
                                "options": {
                                    "textAlign": "right",
                                    "pStyle": "pgStyle"
                                }
                            }
                        },
                        {
                            "action": "addBreak"
                        }
                    ]
                }
            ],
            "data": {
                "first": "wf_text_second_section",
                "default": "wf_content_second_section"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "A new section."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Second page in the second section."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Last page."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.