JSON API - addHeader

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addHeader

PREMIUM

TRIAL / ADVANCED

Inserts headers into a Word document.

Note

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

The contents of the different headers 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) header.
even	The WordFragment containing the contents for the even pages header.
first	The WordFragment containing the contents for the first (title) page header.

Code samples

Example #1

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

Example #2

{
    "wordfragments": [
        {
            "name": "wf_image",
            "target": "defaultHeader",
            "actions": [
                {
                    "action": "addImage",
                    "data": {
                        "src": "image.png",
                        "dpi": 300
                    }
                }
            ]
        },
        {
            "name": "wf_text_first_header",
            "target": "firstHeader",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "first page header."
                    }
                }
            ]
        },
        {
            "name": "wf_text_even_header",
            "target": "evenHeader",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "even page header."
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addHeader",
            "data": {
                "default": "wf_image",
                "first": "wf_text_first_header",
                "even": "wf_text_even_header"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "This is the first page of a document with different headers 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.