XML API - pdx:addCrossReference

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addCrossReference

Inserts a cross-reference into a Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addCrossReference pdx:type="start|end" pdx:referenceName="" pdx:referenceTo="PAGEREF|REF|ABOVE_BELOW" pdx:value="" />
</pdx:content>

This element allows to insert cross-references into a Word document.

Attributes and sub-elements

Key	Description
text	Text of the reference.

options

The options array includes the following keys and values:

Key	Description
type	The bookmark type. Possible values are 'bookmark' and 'heading'.
referenceName	The name of the element to be referred.
referenceTo	Content to display when the field is updated PAGEREF (default, page number), REF (bookmark text content), ABOVE_BELOW (above/below text).

Other styles from addText can also be used.

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:addBookmark pdx:type="start" pdx:name="bookmark_name" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Text that has been bookmarked.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:font pdx:value="Arial" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addBookmark pdx:type="end" pdx:name="bookmark_name" />
        <pdx:addBreak pdx:type="page" pdx:number="1" />
        <pdx:addCrossReference pdx:type="bookmark" pdx:referenceName="bookmark_name" pdx:value="Page-1" />
    </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: