JSON API - addComment

CONTENTS

LAYOUTS

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

addComment

PREMIUM

TRIAL / ADVANCED

Inserts a comment.

Note

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

JSON data

{
    "textDocument": "string" | array,
    "textComment": "string",
    "textComments": array,
    "initials": "string",
    "author": "string",
    "date": "string",
    "completed": boolean,
    "paraId": "string",
    "parentId": "string",
    "pStyle": "string",
    "rStyle": "string"
}

Other styles from createParagraphStyle can be used.

Key	Description
textDocument	string or WordFragment.
textComment	string or WordFragment.
textComments	Add multiple comments.
initials	The initial that will be shown in the comment balloon.
author	The name of the author of the comments.
date	A date string.
completed	False as default, sets the comment as completed. Compatible with MS Word 2013 and later.
paraId	If null, auto generate it. Comment ID. HEX value.
parentId	Reply a comment.
pStyle	Paragraph style. Default as CommentTextPHPDOCX.
rStyle	Character style. Default as CommentReferencePHPDOCX.

Code samples

Example #1

{
    "wordfragments": [
        {
            "name": "wf_comment",
            "actions": [
                {
                    "action": "addComment",
                    "data": {
                        "textDocument": "comment",
                        "textComment": "The comment we want to insert.",
                        "initials": "PT",
                        "author": "PHPDocX Team",
                        "date": "10 September 2000"
                    }
                }
            ]
        }
    ],
    "actions": [
        {
            "action": "addText",
            "data": {
                "text": [
                    { "text": "Here comes the " },
                    { "text": "wf_comment" },
                    { "text": " and some other text." }
                ]
            }
        }
    ]
}

Release notes

phpdocx 18.0:
- new action.