modifyPageLayout

LAYOUT & GENERAL

WORD CONTENT

TEMPLATES

FORMAT CONVERSION

DOCXPATH

DOCXUTILITIES

DOCXPATHUTILITIES

removeSection

PDFUTILITIES

DOCXCUSTOMIZER

customizeWordContent

PERFORMANCE

stream

ENCRYPT

encryptPDF

modifyPageLayout

BASIC / ADVANCED / PREMIUM

Modifies the Word document layout.

Description

public void modifyPageLayout()

public void modifyPageLayout(String paperType)

public void modifyPageLayout(String paperType, OptionsPageLayout options)

This method modifies the main layout properties of the Word document like paper type size and margins.

Parameters

paperType

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

A4
A3
letter
legal
A4-landscape
A3-landscape
letter-landscape
legal-landscape
custom

options

Option	Type	Description
width	Integer	Document width in twips (twentieths of a point).
height	Integer	Document height in twips (twentieths of a point).
numberCols	Integer	Number of columns.
orient	String	Page orientation (portrait or landscape).
marginTop	Integer	Top margin in twips (twentieths of a point).
marginRight	Integer	Right margin in twips (twentieths of a point).
marginBottom	Integer	Bottom margin in twips (twentieths of a point).
marginLeft	Integer	Left margin in twips (twentieths of a point).
marginHeader	Integer	Header margins in twips (twentieths of a point).
marginFooter	Integer	Footer margins in twips (twentieths of a point).
gutter	Integer	Gutter in twips (twentieths of a point). The gutter is only used for binding.
bidi	Boolean	Set to true for right to left languages.
rtlGutter	Integer	RTL gutter.
onlyLastSection	Boolean	If true it only modifies the last section (default value is false).
sectionNumbers	ArrayList<String>	An ArrayList with the sections that you want to modify.

Code samples

Example #1

package examples.LayoutAndGeneral.modifyPageLayout;

import com.javadocx.CreateDocx;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) throws Exception {
        CreateDocx docx = new CreateDocx();
        
        String 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 utaliquip 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.";
        for (int i = 0; i < 50; i++) {
            docx.addText(text);
        }
        
        OptionsPageLayout pageLayoutOptions = new OptionsPageLayout();
        pageLayoutOptions.setNumberCols(3);
        
        docx.modifyPageLayout("A3-landscape", pageLayoutOptions);
        
        docx.createDocx("example_modifyPageLayout_1");
    }
}

The resulting Word document looks like:

Example #2

package examples.LayoutAndGeneral.modifyPageLayout;

import java.util.ArrayList;

import com.javadocx.CreateDocxFromTemplate;
import com.javadocx.elements.*;

public class Sample2 {
    public static void main(String[] args) throws Exception {
        CreateDocxFromTemplate docx = new CreateDocxFromTemplate("src/examples/files/MultipleSections.docx");
        
        ArrayList<String> sectionNumbers = new ArrayList<String>();
        sectionNumbers.add("2");
        
        OptionsPageLayout pageLayoutOptions = new OptionsPageLayout();
        pageLayoutOptions.setNumberCols(2);
        pageLayoutOptions.setSectionNumbers(sectionNumbers);
        
        docx.modifyPageLayout("A4-landscape", pageLayoutOptions);
        
        docx.createDocx("example_modifyPageLayout_2");
    }
}

The resulting Word document looks like: