XML API - pdx:addProperties

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addProperties

Modifies the document properties.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:addProperties>
        <pdx:title>title</pdx:title>
        <pdx:subject>subject</pdx:subject>
        <pdx:creator>creator</pdx:creator>
        <pdx:keywords>keywords</pdx:keywords>
        <pdx:description>description</pdx:description>
        <pdx:category>category</pdx:category>
        <pdx:manager>manager</pdx:manager>
        <pdx:company>company</pdx:company>
        <pdx:created>created</pdx:created>
        <pdx:modified>modified</pdx:modified>
        <pdx:lastModifiedBy>lastModifiedBy</pdx:lastModifiedBy>
        <pdx:contentStatus>contentStatus</pdx:contentStatus>
        <pdx:customProperties>
            <pdx:custom pdx:type="text" pdx:name="">A text</pdx:custom>
            <pdx:custom pdx:type="number" pdx:name="">A number</pdx:custom>
            <pdx:custom pdx:type="date" pdx:name="">A date</pdx:custom>
            <pdx:custom pdx:type="boolean" pdx:name="">true or false</pdx:custom>
        </pdx:customProperties>
    </pdx:addProperties>
</pdx:settings>

This element modifies the properties of the Word document.

With this method it is possible to modify/add the document:

title
subject
author (creator)
keywords
description
category
contentStatus (final, draft...)
created, modified
lastModifiedBy
revision
manager
company
custom properties (name, type and value)

To modify the layout properties you should use modifyPageLayout element instead.

Attributes and sub-elements

Key	Description
title	The title of the document.
subject	The subject of the document.
creator	The document author or creator.
keywords	A list of keywords that may be separated by any character you wish.
description	The description of the document.
category	The category to which you want to associate the document.
manager	The name of the associated Manager.
company	The company name.
contentStatus	The current status of the document: final, draft, ....
created	The created date (W3CDTF without time zone).
modified	The modified date (W3CDTF without time zone).
lastModifiedBy	The username that modified the document.
revision	The revision number.
custom	Custom properties. Each entry is composed by the name of the property and a value.

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:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </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:addProperties>
            <pdx:title>My title</pdx:title>
            <pdx:subject>My subject</pdx:subject>
            <pdx:creator>The creator</pdx:creator>
            <pdx:keywords>keyword 1, keyword 2, keyword 3</pdx:keywords>
            <pdx:description>The description could be much longer than this</pdx:description>
            <pdx:category>My category</pdx:category>
            <pdx:manager>CEO</pdx:manager>
            <pdx:company>My company</pdx:company>
            <pdx:contentStatus>contentStatus</pdx:contentStatus>
            <pdx:customProperties>
                <pdx:custom pdx:type="text" pdx:name="My custom text">This is a reasonably large text</pdx:custom>
                <pdx:custom pdx:type="number" pdx:name="My custom number">4567</pdx:custom>
                <pdx:custom pdx:type="date" pdx:name="My custom date">1962-01-27T23:00:00Z</pdx:custom>
                <pdx:custom pdx:type="boolean" pdx:name="My custom boolean">true</pdx:custom>
            </pdx:customProperties>
        </pdx:addProperties>
    </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: