pdx:addCrossReference

Inserts a cross-reference into a Word document.

Description

Element definition

x
 
1
<pdx:content>
2
    <pdx:addCrossReference pdx:type="bookmark|heading" pdx:referenceName="" pdx:value="" />
3
</pdx:content>
4

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

7
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
3
    <pdx:config>
4
        <pdx:output pdx:name="output" pdx:type="docx" />
5
    </pdx:config>
6
</pdx:document>
7

content.xml

18
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
3
    <pdx:content>
4
        <pdx:addBookmark pdx:type="start" pdx:name="bookmark_name" />
5
        <pdx:addText>
6
            <pdx:textRun>
7
                <pdx:data pdx:dataId="" pdx:dataType="text">Text that has been bookmarked.</pdx:data>
8
                <pdx:textRunStyle>
9
                    <pdx:font pdx:value="Arial" />
10
                </pdx:textRunStyle>
11
            </pdx:textRun>
12
        </pdx:addText>
13
        <pdx:addBookmark pdx:type="end" pdx:name="bookmark_name" />
14
        <pdx:addBreak pdx:type="page" pdx:number="1" />
15
        <pdx:addCrossReference pdx:type="bookmark" pdx:referenceName="bookmark_name" pdx:value="Page-1" />
16
    </pdx:content>
17
</pdx:document>
18

settings.xml

6
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
<pdx:document xmlns:pdx="http://www.phpdocx.com/main">
3
    <pdx:settings>
4
    </pdx:settings>
5
</pdx:document>
6
10
 
1
import os as os
2
import sys as sys
3
sys.path.append(os.path.abspath("wrappers/python/XmlDocx"))
4
import XmlDocx as XmlDocx
5
document = XmlDocx.XmlDocx("config.xml")
6
document.setDocumentProperties("settings.xml")
7
document.addContent("content.xml")
8
document.setXmlDocxPath("xmldocx path")
9
document.render()
10

The resulting Word document looks like: