XML API - pdx:importStyles

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:importStyles

Imports Word styles from an external Word document.

Note

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

Description

Element definition

<pdx:settings>
    <pdx:importStyles pdx:src="" pdx:type="replace|merge" pdx:styleIdentifier="" >
        <pdx:styles>
            <pdx:style pdx:name="" />
            <pdx:style pdx:name="" />
        </pdx:styles>
    </pdx:importStyles>
</pdx:settings>

This element allows to import Word styles from an external Word document.

You may replace the whole stylesheet or just import a certain list of predefined styles.

If you need to know which styles are available for importation from an external Word document you may use the parseStyles element.

Attributes and sub-elements

src

The path to the Word document from which you want to import the styles.

type

The available options are:

‘replace’ if you wish to overwrite the whole stylesheet
‘merge’ if you only want to import the styles listed in the $myStyles array

name

The name of the style that you wish to import.

styleIdentifier

The possible values are:

’styleName’ (default value) if you wish to identify the styles included in $myStyles array by their name.
’styleID’ if you want to use their id.

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">This is the resulting paragraph with the "CrazyStyle".</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
                <pdx:paragraphStyle>
                    <pdx:pStyle pdx:value="crazyStyle" />
                </pdx:paragraphStyle>
            </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:importStyles pdx:src="/var/www/phpdocx/samples/files/TemplateStyles.docx" pdx:importType="merge" pdx:styleIdentifier="styleName" >
            <pdx:styles>
                <pdx:style pdx:name="crazyStyle" />
            </pdx:styles>
        </pdx:importStyles>
    </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: