JSON API - replaceBlock

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceBlock

PREMIUM

TRIAL / ADVANCED

Replaces all content between two block variables from the Word document.

Note

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

JSON data

{
    "name": "string",
    "value": "string",
    "type": "string"
}

Key	Description
name	The name of the block variable.
value	New content: string or WordFragment.
type	Replacement type: block (default) or inline.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "replaceBlock",
            "data": {
                "name": "FIRST",
                "value": "New content."
            }
        }
    ]
}

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

Example #2

{
    "template": "template.docx",
    "wordfragments": [
        {
            "name": "wf_content",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "New content",
                        "optionsParagraph": {
                            "bold": true
                        }
                    }
                },
                {
                    "action": "addTable",
                    "data": {
                        "values": [
                            ["11", "12", "13", "14"],
                            ["21", "22", "23", "24"],
                            ["31", "32", "33", "34"]
                        ],
                        "tableProperties": {
                            "border": "single",
                            "tableAlign": "center",
                            "borderWidth": 10,
                            "borderColor": "B70000"
                        }
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "replaceBlock",
            "data": {
                "name": "FIRST",
                "value": "wf_content"
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.