JSON API - cloneBlock

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

cloneBlock

PREMIUM

TRIAL / ADVANCED

Clones a block in the document.

Note

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

JSON data

{
    "name": "string",
    "occurrence": number,
    "variables": object,
    "removeBlockPlaceholder": boolean,
    "type": "string"
}

Key	Description
name	The name of the block to be cloned.
occurrence	Position of the block to be cloned. 1 as default.
variables	This must be an object with the names of the placeholder block variables as keys and the plain text or WordFragment that should replace them as values. The "images" key can be added to do image replacements.
removeBlockPlaceholder	False as default. If true, remove block placeholders from the cloned content.
type	Possible values are: inline (default) or block. Used by WordFragment values.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "cloneBlock",
            "data": {
                "name": "FIRST"
            }
        },
        {
            "action": "clearBlocks"
        }
    ]
}

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

Example #2

{
    "template": "template.docx",
    "actions": [
        {
            "action": "cloneBlock",
            "data": {
                "name": "EXAMPLE"
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "EXAMPLE"
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "SUB_1"
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "SUB_1",
                "occurrence": 2
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "SUB_1",
                "occurrence": 4
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "SUB_2",
                "occurrence": 2
            }
        },
        {
            "action": "cloneBlock",
            "data": {
                "name": "SUB_2"
            }
        },
        {
            "action": "clearBlocks"
        }
    ]
}

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

Example #3

{
    "template": "template.docx",
    "wordfragments": [
        {
            "name": "wf_image",
            "actions": [
                {
                    "action": "addImage",
                    "data": {
                        "src": "image.png",
                        "scaling": 50
                    }
                }
            ]
        },
        {
            "name": "wf_link",
            "actions": [
                {
                    "action": "addLink",
                    "data": {
                        "text": "Link to website",
                        "options": {
                            "url": "https://www.phpdocx.com"
                        }
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "cloneBlock",
            "data": {
                "name": "FIRST",
                "occurrence": 1,
                "variables": [
                    {
                        "VAR_MEMBER": "John Doe",
                        "VAR_CONTENT": "wf_image",
                        "VAR_DATE": "11/08/2021"
                    },
                    {
                        "VAR_MEMBER": "Jane Doe",
                        "VAR_CONTENT": "wf_link",
                        "VAR_DATE": "21/08/2021"
                    }
                ],
                "options": {
                    "removeBlockPlaceholder": true
                }
            }
        },
        {
            "action": "deleteBlock",
            "data": {
                "name": "FIRST"
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.