JSON API - replaceVariableByWordFragment

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

replaceVariableByWordFragment

PREMIUM

TRIAL / ADVANCED

Replaces placeholder variables by fragments of Word.

Note

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

JSON data

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

Key	Description
variables	The names of the placeholder template variables as keys and the WordFragments 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.
stylesReplacementType	Empty as default. usePlaceholderStyles: keeps placeholder styles, styles from the imported WordFragment are ignored. Applies to the following styles: pPr, rPr. mixPlaceholderStyles: mixes placeholder styles, placeholder styles overwrite WordFragment styles with the same name. Applies to the following styles: pPr, rPr.
stylesReplacementTypeIgnore	Styles to be ignored from the imported WordFragment. Use with mixPlaceholderStyles. Empty as default.
stylesReplacementTypeOverwrite	If true, WordFragment styles overwrite placeholder styles with the same name that are not set in the stylesReplacementTypeIgnore option. Use with mixPlaceholderStyles. Default as false. Only available in Premium licenses.
target	Possible values are: document (default), header, footer, footnote, endnote, comment. This option sets the scope of the replacement procedure.
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). inline-block: replaces the variable keeping inline and block elements. Only available in Premium licenses.

Code samples

Example #1

{
    "template": "template.docx",
    "wordfragments": [
        {
            "name": "wf_image",
            "actions": [
                {
                    "action": "addImage",
                    "data": {
                        "src": "image.png",
                        "scaling": 50,
                        "textWrap": 1,
                        "float": "right"
                    }
                }
            ]
        },
        {
            "name": "wf_link",
            "actions": [
                {
                    "action": "addLink",
                    "data": {
                        "text": "link to Google",
                        "options": {
                            "url": "https://www.google.com",
                            "color": "0000FF",
                            "underline": "single"
                        }
                    }
                }
            ]
        },
        {
            "name": "wf_footnote",
            "actions": [
                {
                    "action": "addFootnote",
                    "data": {
                        "textDocument": "here it is",
                        "textFootnote": "This is the footnote text."
                    }
                }
            ]
        },
        {
            "name": "wf_text",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": [
                            { "text": "wf_image" },
                            { "text": "I am going to write a link: ", "bold": true },
                            { "text": "wf_link" },
                            { "text": " to illustrate how to include links."},
                            { "text": " As you may see it is extremely simple to do so and it can be done with any other Word element. For example to include  a footnote is also as simple as this: "},
                            { "text": "wf_footnote" },
                            { "text": " , as you may check there is a footnote at the bottom of the page.", "color": "B70000" }
                        ]
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "replaceVariableByWordFragment",
            "data": {
                "variables": {
                    "WORDFRAGMENT": "wf_text"
                },
                "options": {
                    "type": "block"
                }
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.