JSON API - addHeaderSection

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addHeaderSection

PREMIUM

TRIAL / ADVANCED

Inserts headers in a specific section of a Word document.

Note

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

The contents of the different headers 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) header.
even	The WordFragment containing the contents for the even pages header.
first	The WordFragment containing the contents for the first (title) page header.
section	Section position. -1 as default. 0 is the first section and -1 the last section.
removeOthers	If true remove other headers in the section. Default as false.

Code samples

Example #1

{
    "actions": [
        {
            "action": "createParagraphStyle",
            "data": {
                "name": "pgStyle",
                "options": {
                    "bold": true,
                    "color": "B70000",
                    "fontSize": 24
                }
            }
        },
        {
            "action": "addHeaderSection",
            "wordfragments": [
                {
                    "name": "wf_text_first_section",
                    "target": "firstHeader",
                    "actions": [
                        {
                            "action": "addText",
                            "data": {
                                "text": "Header in the first section"
                            }
                        }
                    ]
                },
                {
                    "name": "wf_image_first_section",
                    "target": "defaultHeader",
                    "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 header with a text in the first header and an image as default header."
            }
        },
        {
            "action": "addBreak",
            "data": {
                "type": "page"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "Second page"
            }
        },
        {
            "action": "addSection"
        },
        {
            "action": "addHeaderSection",
            "wordfragments": [
                {
                    "name": "wf_text_second_section",
                    "target": "firstHeader",
                    "actions": [
                        {
                            "action": "addText",
                            "data": {
                                "text": "Header in the second section"
                            }
                        }
                    ]
                },
                {
                    "name": "wf_content_second_section",
                    "target": "defaultHeader",
                    "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.