XML API - pdx:docxSettings

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:docxSettings

Modifies the general Word settings.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:docxSettings>
        <pdx:autoHyphenation pdx:value="" />
        <pdx:bookFoldPrinting pdx:value="" />
        <pdx:bookFoldPrintingSheets pdx:value="" />
        <pdx:bookFoldRevPrinting pdx:value="" />
        <pdx:bordersDoNotSurroundHeader pdx:value="" />
        <pdx:bordersDoNotSurroundFoote pdx:value="" />
        <pdx:consecutiveHyphenLimit pdx:value="" />
        <pdx:defaultTableStyle pdx:value="" />
        <pdx:defaultTabStop pdx:value="" />
        <pdx:documentType pdx:value="" />
        <pdx:doNotHyphenateCaps pdx:value="" />
        <pdx:doNotShadeFormData pdx:value="" />
        <pdx:gutterAtTop pdx:value="" />
        <pdx:hideGrammaticalErrors pdx:value="" />
        <pdx:hideSpellingErrors pdx:value="" />
        <pdx:hyphenationZone pdx:value="" />
        <pdx:mirrorMargins pdx:value="" />
        <pdx:noPunctuationKerning pdx:value="" />
        <pdx:printTwoOnOne pdx:value="" />
        <pdx:savePreviewPicture pdx:value="" />
        <pdx:trackRevisions pdx:value="" />
        <pdx:updateFields pdx:value="" />
        <pdx:view pdx:value="" />
        <pdx:zoom pdx:value="" />
        <pdx:customSettings>
            <pdx:customSetting pdx:tag="">
                <pdx:attribute pdx:name="">value</pdx:attribute>
                <pdx:attribute pdx:name="">value</pdx:attribute>
            </pdx:customSetting>
        </pdx:customSettings>
        <pdx:compat>
            <pdx:attribute pdx:name="">value</pdx:attribute>
            <pdx:attribute pdx:name="">value</pdx:attribute>
        </pdx:compat>
    </pdx:docxSettings>
</pdx:settings>

With the help of this element you can set, among many other features:/p>

The way the Word document will print.
The view mode and zoom of the Word document at opening.
To hide or show grammatical and/or spelling errors.
To track or not revisions.
The document type.
Hyphenation settings.
Default table style and tab positioning.
Etcetera.

If you need to alter the setting of pre-existing Word documents you may use the modifyDocxSettings element available in the DocxUtilities package.

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">In this case we set the view mode as "outline" and the default zoom on opening to 70%.</pdx:data>
                <pdx:textRunStyle>
                </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:docxSettings>
            <pdx:view pdx:value="outline" />
            <pdx:zoom pdx:value="70" />
        </pdx:docxSettings>
    </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: