JSON API - tickCheckboxes

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

tickCheckboxes

PREMIUM

TRIAL / ADVANCED

Ticks or unticks a checkbox in a Word document.

Note

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

JSON data

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

Key	Description
variables	Names of the merge 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 replace the first occurrence of the variable within the Word document.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "tickCheckboxes",
            "data": {
                "variables": {
                    "check1": 1,
                    "check2": 0,
                    "check3": 1
                }
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.