JSON API - replaceTableVariable

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceTableVariable

PREMIUM

TRIAL / ADVANCED

Replaces a group of variables within a set of table rows.

Note

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

JSON data

{
    "variables": array,
    "options": {
        "firstMatch": boolean,
        "target": "string",
        "parseLineBreaks": boolean,
        "type": "string",
        "addExtraSiblingNodes": boolean,
        "wordFragmentOptions": {
            "stylesReplacementType": "string",
            "stylesReplacementTypeIgnore": object,
            "stylesReplacementTypeOverwrite": boolean
        }
    }
}

Key	Description
variables	This has to be an array. The keys of the associative array should match the names of the variables that you want to replace by their corresponding values (text strings or WordFragments).
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.
target	Possible values are: document (default), header, footer. This option sets the scope of the replacement procedure.
parseLineBreaks	If true (default is false) parses the line breaks to include them in the Word document.
type	inline (default) or block; used by WordFragment values.
addExtraSiblingNodes	If true (default is false) parses and adds nodes that don't have placeholders between placeholders.
wordFragmentOptions	stylesReplacementType (string): usePlaceholderStyles (keep placeholder styles, styles from the imported HTML are ignored), mixPlaceholderStyles (mix placeholder styles, placeholder styles overwrite HTML styles with the same name). Applies to the following styles: pPr, rPr stylesReplacementTypeIgnore (object): styles to be ignored from the imported WordFragment. Use with mixPlaceholderStyles stylesReplacementTypeOverwrite (boolean): if true, overwrite the placeholder styles don't set in stylesReplacementTypeIgnore. Use with mixPlaceholderStyles. Default as false

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "replaceTableVariable",
            "data": {
                "variables": [
                    {
                        "ITEM": "Product A",
                        "REFERENCE": "107AW3"
                    },
                    {
                        "ITEM": "Product B",
                        "REFERENCE": "204RS67O"
                    },
                    {
                        "ITEM": "Product C",
                        "REFERENCE": "25GTR56"
                    }
                ]
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.