JSON API - setTemplateSymbol

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

setTemplateSymbol

PREMIUM

TRIAL / ADVANCED

Sets the character or characters used to identify placeholder variables within a given template.

Note

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

JSON data

{
    "start": "string",
    "end": "string"
}

Key	Description
start	The character or symbol to be used for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable.
end	The character or symbol to be used at the end for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable. If it has a value, it uses "start" at the beginning and "end" at the end. phpdocx recommends using ${ } to wrap placeholders that don't use the same symbol at the beginning and the end. For further information, please read the documentation available on Defining a non unique symbol for placeholders.

Key

Description

start

The character or symbol to be used for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable.

end

The character or symbol to be used at the end for identifying placeholder variables within templates. If "end" is null, it uses "start" at the beginning and the end of the variable. If it has a value, it uses "start" at the beginning and "end" at the end.

phpdocx recommends using ${ } to wrap placeholders that don't use the same symbol at the beginning and the end. For further information, please read the documentation available on Defining a non unique symbol for placeholders.

Code samples

Example #1

{
    "template": "template.docx",
    "actions": [
        {
            "action": "setTemplateSymbol",
            "data": {
                "start": "|"
            }
        },
        {
            "action": "replaceVariableByText",
            "data": {
                "variables": {
                    "FIRST": "Hello World!"
                }
            }
        }
    ]
}

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

Example #2

{
    "template": "template.docx",
    "actions": [
        {
            "action": "setTemplateSymbol",
            "data": {
                "start": "${",
                "end": "}"
            }
        },
        {
            "action": "replaceVariableByText",
            "data": {
                "variables": {
                    "FIRST": "Hello World!"
                }
            }
        }
    ]
}

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

Release notes

phpdocx 18.0:
- new action.