XML API - pdx:addComment

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addComment

Inserts a comment into the Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addComment pdx:initials="" pdx:author="" pdx:date="" pdx:wordFragmentName="">
        <pdx:textDocument>
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
            <pdx:paragraphStyle />
        </pdx:textDocument>
        <pdx:textComment pdx:wordFragmentName="">
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:textComment>
    </pdx:addComment>
</pdx:content>

This element allows the insertion of a Word comment into the current Word document.

You may fully customize the comment content including all kind of elements like paragraphs of text with sophisticated formatting, images, links or even tables and HTML content.

If one wishes to insert a comment within a complex paragraph one should use this element in combination with the addText element.

Attributes and sub-elements

Key	Description
initials	The initial that will be shown in the comment balloon.
author	The name of the author of the comments.
date	A date string as the ones used for the strtotime PHP method.

Code samples

Example #1

config.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:config>
        <pdx:output pdx:name="output" pdx:type="docx" />
    </pdx:config>
</pdx:document>

content.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:content>
        <pdx:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="commentFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addComment pdx:initials="PT" pdx:author="PHPDocX Team" pdx:date="10 September 2000">
                        <pdx:textDocument>
                            <pdx:data pdx:dataId="" pdx:dataType="text">comment</pdx:data>
                            <pdx:paragraphStyle />
                        </pdx:textDocument>
                        <pdx:textComment>
                            <pdx:data pdx:dataId="" pdx:dataType="text">The comment we want to insert.</pdx:data>
                        </pdx:textComment>
                    </pdx:addComment>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Here comes the </pdx:data>
            </pdx:textRun>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="wordFragment">commentFragment</pdx:data>
            </pdx:textRun>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text"> and some other text.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
    </pdx:content>
</pdx:document>

settings.xml

<?xml version="1.0" encoding="UTF-8"?>
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
    <pdx:settings>
    </pdx:settings>
</pdx:document>

PHP code

require_once 'path_to_phpdocx/classes/CreateDocx.php';

$docx = new XMLAPI('config.xml');
$docx->setDocumentProperties('settings.xml');
$docx->addContent('content.xml');

$docx->render();

The resulting Word document looks like: