pdx:addCrossReference Inserts a cross-reference into a Word document

pdx:addCrossReference

Inserts a cross-reference into a Word document.

Description

Element definition

<pdx:content>
    <pdx:addCrossReference pdx:type="bookmark|heading" pdx:referenceName="" pdx:value="" />
</pdx:content>

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

Attributes and sub-elements

options

key	Description
type	The bookmark type. Possible values are 'bookmark' and 'heading'.
referenceName	the name of the element to be referred.

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>

import os as os
import sys as sys
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
import XmlDocx as XmlDocx
document = XmlDocx.XmlDocx("config.xml")
document.setDocumentProperties("settings.xml")
document.addContent("content.xml")
document.setXmlDocxPath("xmldocx path")
document.render()

The resulting Word document looks like: