JSON API - modifyInputFields

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

modifyInputFields

PREMIUM

TRIAL / ADVANCED

Modifies the values associated with Word template input fields.

Note

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

JSON data

{
    "variables": object,
    "options": {
        "firstMatch": boolean,
        "target": "string"
    }
}

Key	Description
variables	Names of the input fields as keys and their corresponding values.
firstMatch	If the variable appears more than once within the Word document and firstMatch is set to true, phpdocx will only modify the first occurrence of the variable within the Word document.
target	Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "modifyInputFields",
            "data": {
                "variables": {
                    "textfield_1": "first",
                    "textfield_2": "second",
                    "sdt_1": "third",
                    "sdt_2": "fourth"
                }
            }
        }
    ]
}

A template can be a local file, a Base64 string, or a remote file.

Release notes

phpdocx 18.0:
- new action.