JSON API - addStructuredDocumentTag

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addStructuredDocumentTag

PREMIUM

TRIAL / ADVANCED

Inserts Structured Document Tags.

Note

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

JSON data

{
    "type": "string",
    "options": {
        "alias": "string",
        "calendar": "string",
        "checked": boolean,
        "checkedState": {
            "font": "string",
            "value": "string"
        },
        "dateFormat": "string",
        "listItems": array,
        "local": "string",
        "lock": "string",
        "parseLineBreaks": boolean,
        "placeholderText": "string",
        "sym": {
            "font": "string",
            "char": "string"
        },
        "tag": "string",
        "temporary": boolean,
        "text": "string",
        "uncheckedState": {
            "font": "string",
            "value": "string"
        },
        "wordfragment": "string"
        /* check addText styles */
    }
}

Styles from addText can be used.

Key	Description
type	checkbox comboBox date dropdownList richText text
alias	The label that will be shown in the structured document tag.
calendar	Calendar type. Default type is gregorian. Possible values include: gregorian, hijri, hebrew, taiwan, japan, thai, korea, saka, gregorianXlitEnglish, gregorianXlitFrench.
checked	Set checkboxes as checked or unchecked.
checkedState	"font": MS Gothic as default. "value": 2612 as default for checkedState. 2610 as default for uncheckedState.
dateFormat	The default date format is M/d/yyyy. See addDateAndHour for available date formats.
listItems	An array of arrays each one of them containing the text to show and value.
local	ISO code. The default value is en-US.
lock	Locking properties: "sdtLocked" (cannot be deleted). "contentLocked" (contents can not be edited directly). "unlocked" (default value: no locking). "sdtContentLocked" (contents can not be directyly edited or the structured tag removed).
parseLineBreaks	If true parses the line breaks to include them in the Word document: richText and text types. Default as false.
placeholderText	Text to be shown by default.
sym	Custom symbol used with checkbox. Use with checkedState and uncheckedState options. "font" "char"
tag	A programmatic tag.
temporary	If true the structured tag is removed after editing.
text	Add text content without adding a placeholder: richText and text types.
uncheckedState	"font": MS Gothic as default. "value": 2612 as default for checkedState. 2610 as default for uncheckedState.
wordfragment	Add WordFragment content without adding a placeholder: richText type.

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_contents_1",
            "actions": [
                {
                    "action": "addText",
                    "data": {
                        "text": "Text content"
                    }
                },
                {
                    "action": "embedHTML",
                    "data": {
                        "html": "<p style=\"font-weight: bold;\">Additional text content</p>"
                    }
                }
            ]
        },
        {
            "name": "wf_checkbox",
            "actions": [
                {
                    "action": "addStructuredDocumentTag",
                    "data": {
                        "type": "checkbox",
                        "options": {
                            "fontSize": 11,
                            "checked": true
                        }
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "comboBox",
                "options": {
                    "listItems": [
                        ["First Choice", 1],
                        ["Second Choice", 2],
                        ["Third Choice", 3]
                    ],
                    "placeholderText": "Choose a value or write it down",
                    "alias": "Combo Box",
                    "fontSize": 12,
                    "italic": true,
                    "color": "FF0000",
                    "bold": true,
                    "underline": "single",
                    "font": "Algerian"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "date",
                "options": {
                    "placeholderText": "Choose a date",
                    "alias": "Date picker",
                    "fontSize": 14,
                    "italic": true,
                    "color": "777777",
                    "bold": true,
                    "font": "Calibri"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "comboBox",
                "options": {
                    "listItems": [
                        ["One", 1],
                        ["Two", 2],
                        ["Three", 3]
                    ],
                    "placeholderText": "Choose a value",
                    "alias": "Dropdown menu",
                    "fontSize": 12
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "richText",
                "options": {
                    "placeholderText": "This text is locked",
                    "alias": "Rich text",
                    "lock": "contentLocked"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "richText",
                "options": {
                    "text": "Rich text content 2\nMore content",
                    "parseLineBreaks": true,
                    "bold": true
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "text",
                "options": {
                    "text": "Text sdt"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "richText",
                "options": {
                    "wordfragment": "wf_contents_1"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "checkbox",
                "options": {
                    "fontSize": 18,
                    "checked": true
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "checkbox",
                "options": {
                    "fontSize": 18,
                    "checked": true,
                    "highlightColor": "red"
                }
            }
        },
        {
            "action": "addStructuredDocumentTag",
            "data": {
                "type": "checkbox",
                "options": {
                    "fontSize": 18,
                    "checked": true,
                    "checkedState": {
                        "font": "Wingdings",
                        "value": "00FE"
                    },
                    "uncheckedState": {
                        "font": "Wingdings",
                        "value": "006F"
                    },
                    "sym": {
                        "font": "Wingdings",
                        "char": "00FE"
                    }
                }
            }
        },
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "Checkbox: ", "fontSize": 12 },
                    { "text": "wf_checkbox" }
                ]
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.