XML API - pdx:addFootnote

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

CRYPTOPHPDOCX

DIGITAL SIGNATURE

pdx:addFootnote

Inserts a footnote into the Word document.

Note

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

Description

Element definition

<pdx:content>
    <pdx:addFootnote pdx:wordFragmentName="">
        <pdx:textDocument>
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
            <pdx:paragraphStyle />
        </pdx:textDocument>
        <pdx:textFootnote>
            <pdx:data pdx:dataId="" pdx:dataType="text">text</pdx:data>
        </pdx:textFootnote>
        <pdx:footnoteMark pdx:customMark="">
            <pdx:textRunStyle>
                <pdx:bold pdx:value="" />
                <pdx:caps pdx:value="" />
                <pdx:color pdx:value="" />
                <pdx:font pdx:value="" />
                <pdx:fontSize pdx:value="" />
                <pdx:italic pdx:value="" />
                <pdx:rtl pdx:value="" />
                <pdx:smallCaps pdx:value="" />
                <pdx:textAlign pdx:value="" />
                <pdx:underline pdx:value="" />
            </pdx:textRunStyle>
        </pdx:footnoteMark>
        <pdx:referenceMark>
            <pdx:textRunStyle>
                <pdx:bold pdx:value="" />
                <pdx:caps pdx:value="" />
                <pdx:color pdx:value="" />
                <pdx:font pdx:value="" />
                <pdx:fontSize pdx:value="" />
                <pdx:italic pdx:value="" />
                <pdx:rtl pdx:value="" />
                <pdx:smallCaps pdx:value="" />
                <pdx:textAlign pdx:value="" />
                <pdx:underline pdx:value="" />
            </pdx:textRunStyle>
        </pdx:referenceMark>
    </pdx:addFootnote>
</pdx:content>

This element allows the insertion of a footnote into the Word document.

You may fully customize the footnote content including all kind of elements like paragraphs of text with sophisticated formatting, images, links or even tables and HTML content.

If one wishes to insert a footnote within a complex paragraph one should use this element in combination with the addText element.

Attributes and sub-elements

options

Key	Description
textDocument	This can be a string of text that will appear in the Word document just before the footnote call or an array with the text and the formatting options (as in the addText method) or a Word fragment.
textFootnote	This is a string of text that will show up in the corresponding footnote or a Word fragment that may include a variety of elements.
footnoteMark	The keys of this array are: 'customMark': a special character, if any, that you would like to use for the call to the footnote content. 'font': the font family you wish to use (Arial, Calibri...). 'bold': true or false for bold text. 'bidi': true for right to left languages. 'italic': true or false to turn on italics. 'color': an hexadecimal color ('000000', 'FF0000'...). 'rtl': true for right to left languages.
referenceMark	The keys of this array are: 'font': the font family you wish to use (Arial, Calibri...). 'bold': true or false for bold text. 'bidi': true for right to left languages. 'italic': true or false to turn on italics. 'color': an hexadecimal color ('000000', 'FF0000'...). 'rtl': true for right to left languages.

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:wordFragments>
            <pdx:wordFragment pdx:wordFragmentName="footnoteFragment" pdx:target="document">
                <pdx:content>
                    <pdx:addFootnote>
                        <pdx:textDocument>
                            <pdx:data pdx:dataId="" pdx:dataType="text">footnote</pdx:data>
                        </pdx:textDocument>
                        <pdx:textFootnote>
                            <pdx:data pdx:dataId="" pdx:dataType="text">The footnote you want to insert.</pdx:data>
                        </pdx:textFootnote>
                    </pdx:addFootnote>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Here comes the </pdx:data>
            </pdx:textRun>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="wordFragment">footnoteFragment</pdx:data>
            </pdx:textRun>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text"> and some other text.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Some other text.</pdx:data>
            </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: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: