JSON API - replaceVariableByWordML

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceVariableByWordML

PREMIUM

TRIAL / ADVANCED

Replaces placeholder variables by plain WordML code.

Note

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

JSON data

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

Key	Description
variables	The names of the placeholder template variables as keys and the plain text that should replace them as 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.
type	Possible values are: block (default): replaces the variable and removes its containing paragraph. inline: only replaces the variable by the WordFragment inline content (it may be used to replace a variable by formatted text).
target	Possible values are: document. This option sets the scope of the replacement procedure.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "replaceVariableByWordML",
            "data": {
                "variables": {
                    "WORDML": "<w:p><w:r><w:t xml:space=\"preserve\">This is a simple paragraph with some </w:t></w:r><w:r><w:rPr><w:b/></w:rPr><w:t>bold</w:t></w:r><w:r><w:t xml:space=\"preserve\"> text.</w:t></w:r></w:p>"
                }
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.