pdx:addPageNumber Inserts the current page number into the Word document

pdx:addPageNumber

Inserts the current page number into the Word document.

Description

Element definition

<pdx:content>
    <pdx:addPageNumber pdx:numberType="numerical|alphabetical|page-of" pdx:defaultValue="" pdx:wordFragmentName="" pdx:pStyle="" pdx:textAlign="center|left|right">
        <pdx:paragraphStyle />
    </pdx:addPageNumber>
</pdx:content>

This element allows you to insert automatic page numbering into your Word document.

If the page number is not added to a header or footer the user may need to press F9 in the MS Word interface to update its value to the current page.

Attributes and sub-elements

numberType

The possible values are numerical (default), alphabetical or page-of.

numberType

The possible values are numerical (default), alphabetical or page-of.

options

The possible keys and values are:

key	Description
pStyle	The WordML fragment object containing the contents for the even pages header
backgroundColor	Hexadecimal color value: FF0000, 000000...
bidi	Set to true for right to left languages like Hebrew or Arabic.
bold	If true the text will be shown in bold characters.
border	Available values are: none (default) double dashed outset inset threeDEmboss threeDEngrave You can access to the complete list in: Border Styles.
borderBottom	Overwrites the general border type for the bottom border of the paragraph.
borderLeft	Overwrites the general border type for the left border of the paragraph.
borderTop	Overwrites the general border type for the top border of the paragraph.
borderRight	Overwrites the general border type for the right border of the paragraph.
borderColor	Hexadecimal color value: FF0000, 000000...
borderBottomColor	Overwrites the general border color for the bottom border of the paragraph.
borderLeftColor	Overwrites the general border color for the left border of the paragraph.
borderTopColor	Overwrites the general border color for the top border of the paragraph.
borderRightColor	Overwrites the general border color for the right border of the paragraph.
borderSpacing	Separation between border and text in points.
borderBottomSpacing	Overwrites the general border spacing for the bottom border of the paragraph.
borderLeftSpacing	Overwrites the general border spacing for the left border of the paragraph.
borderTopSpacing	Overwrites the general border spacing for the top border of the paragraph.
borderRightSpacing	Overwrites the general border spacing for the right border of the paragraph.
borderWidth	Border width in eigths of a point.
borderBottomWidth	Overwrites the general border width for the bottom border of the paragraph.
borderLeftWidth	Overwrites the general border width for the left border of the paragraph.
borderTopWidth	Overwrites the general border width for the top border of the paragraph.
borderRightWidth	Overwrites the general border width for the right border of the paragraph.
caps	If true displays text in capital letters.
color	Hexadecimal color value: 'FF0000', '000000'...
contextualSpacing	If true ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style (false by default).
firstLineIndent	First line indentation in twentieths of a point (twips).
font	Font family: 'Arial', Calibri'...
fontSize	Font size in points.
hanging	Paragraph hanging in twentieths of a point (twips).
headingLevel	The heading level if we want this paragraph to be a heading.
italic	If true displays the text in italics.
indentLeft	Left margin in points.
indentRight	Right margin in points
keepLines	Keeps (whenever possible) all the current paragraph lines on the same page (default value is false).
keepNext	Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false).
lineSpacing	1 corresponds to single line spacing, 2 to double line spacing and so long so forth. It admits decimal numbers.
pageBreakBefore	If true forces a page break before the paragraph.
rtl	Set to true for right to left languages like Hebrew or Arabic.
smallCaps	If true displays text in small capital letters.
spacingBottom	Bottom padding in twentieths of a point
spacingTop	Top padding in twentieths of a point
textAlign	Text alignment within paragraphs. Possible values are: center, right, both and distribute.
textDirection	Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV.
underline	Underlines text. Possible values are: single, words, double, dotted, dash and wave.
widowControl	Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan).
wordWrap	Allows line breaking at character level (default value is false).

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="pageNumberFragment" pdx:target="defaultHeader">
                <pdx:content>
                    <pdx:addPageNumber pdx:numberType="numerical">
                        <pdx:paragraphStyle>
                            <pdx:bold pdx:value="true" />
                            <pdx:color pdx:value="B70000" />
                            <pdx:sz pdx:value="14" />
                            <pdx:textAlign pdx:value="right" />
                        </pdx:paragraphStyle>
                    </pdx:addPageNumber>
                </pdx:content>
            </pdx:wordFragment>
        </pdx:wordFragments>
        <pdx:addHeader>
            <pdx:default pdx:wordFragmentName="pageNumberFragment" />
        </pdx:addHeader>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is the first page.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addBreak pdx:type="page" pdx:number="1" />
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is the second page.</pdx:data>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addBreak pdx:type="page" pdx:number="1" />
         <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">This is the third page.</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>

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: