JSON API - addFormElement

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addFormElement

PREMIUM

TRIAL / ADVANCED

Inserts a form element.

Note

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

JSON data

{
    "type": "string",
    "options": {
        "defaultValue": "string" | number | boolean,
        "selectOptions": array,
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
type	textfield checkbox select
defaultValue	A string of text for the textfield type, a boolean value for the checkbox type or a number representing the index (0 based) for the options of a select form element.
selectOptions	Options for the dropdown menu.

Code samples

Example #1

{
    "actions": [
        {
            "action": "addFormElement",
            "data": {
                "type": "textfield",
                "options": {
                    "fontSize": 12,
                    "italic": true,
                    "color": "0000CC",
                    "bold": true,
                    "font": "Arial",
                    "defaultValue": "This is a test"
                }
            }
        },
        {
            "action": "addFormElement",
            "data": {
                "type": "checkbox",
                "options": {
                    "fontSize": 12,
                    "defaultValue": true
                }
            }
        },
        {
            "action": "addFormElement",
            "data": {
                "type": "select",
                "options": {
                    "selectOptions": ["One", "Two (selected)", "Three", "Four"],
                    "fontSize": 14,
                    "color": "C90000",
                    "bold": true,
                    "underline": "double",
                    "font": "Algerian",
                    "defaultValue": 1
                }
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.