pdx:addSection Inserts a new section into the Word document

pdx:addSection

Inserts a new section into the Word document.

Description

Element definition

<pdx:content>
    <pdx:addSection pdx:type="nextPage|nextColumn|continuous|evenPage|oddPage" pdx:paperType="A4|A3|letter|legal|A4-landscape|A3-landscape|letter-landscape|legal-landscape|custom" pdx:wordFragmentName="">
        <pdx:layout> 
            <pdx:width pdx:value="" />
            <pdx:height pdx:value="" />
            <pdx:numberCols pdx:value="" />
            <pdx:orient pdx:value="portrait|landscape" />
            <pdx:marginTop pdx:value="" />
            <pdx:marginRight pdx:value="" />
            <pdx:marginBottom pdx:value="" />
            <pdx:marginLeft pdx:value="" />
            <pdx:marginHeader pdx:value="" />
            <pdx:marginFooter pdx:value="" />
            <pdx:gutter pdx:value="" />
            <pdx:bidi pdx:value="" />
            <pdx:rtl pdx:value="" />
        </pdx:layout>
    </pdx:addSection>
</pdx:content>

This element allows the creation of new sections in your Word document.

This option is needed if you wish to change the page properties, for example, from portrait to landscape orientation in part of your Word document.

All content inserted after a call to this element will be incorporated into the new section.

Attributes and sub-elements

type

These parameters determines the kind of break (if any) used. The possible values are:

nextPage (default value): the new section starts in a new page,
nextColumn: the new section starts in the following column,
continuous: there is no break between sections,
evenPage: the new section starts in the next available even page and
oddPage: the new section starts in the next available odd page.

paperType

The type of paper to be used. The possible values are:

A4,
A3,
letter,
legal,
A4-landscape,
letter-landscape,
legal-landscape and
custom.

This element is only required if the paperType element has been set up to custom.

key	Description
width	Section width in twips (twentieths of a point).
height	Section height in twips.
numberCols	Number of columns for this section.
orient	Section page orientation (portrait or landscape).
marginTop	Top margin for this section in twips.
marginRight	Right margin for this section in twips.
marginBottom	Bottom margin for this section in twips.
marginLeft	Left margin for this section in twips.
marginHeader	Header margin in twips.
marginFooter	Footer margin in twips.
gutter	Gutter in twips (used for binding).

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:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                </pdx:textRunStyle>
            </pdx:textRun>
        </pdx:addText>
        <pdx:addSection pdx:type="nextPage" pdx:paperType="A3">
            <pdx:layout> 
                <pdx:numberCols pdx:value="3" />
            </pdx:layout>
        </pdx:addSection>
        <pdx:addText>
            <pdx:textRun>
                <pdx:data pdx:dataId="" pdx:dataType="text">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</pdx:data>
                <pdx:textRunStyle>
                    <pdx:bold pdx:value="true" />
                </pdx:textRunStyle>
            </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()

Download