JSON API - addExternalFile

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addExternalFile

PREMIUM

TRIAL / ADVANCED

Inserts an external document (DOCX, HTML, RTF or MHT) into a Word document.

Note

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

JSON data

{
    "src": "string",
    "matchSource": boolean,
    "preprocess": boolean
}

Key	Description
src	Path to the local file or Base64 string or remote file to be inserted into the Word document.
matchSource	If true (default value), it tries to preserve as much as possible the styles of the DOCX to be included.
preprocess	If true it does some preprocessing on the DOCX file to add.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": "We are going to insert now a Word document. Beware that this method is not compatible with legacy versions of Word running the docx compatibility pack."
            }
        },
        {
            "action": "addExternalFile",
            "data": {
                "src": "file.docx"
            }
        },
        {
            "action": "addText",
            "data": {
                "text": "A new paragraph."
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.