PageSetup
Inheritance: java.lang.Object
public class PageSetup
Represents the page setup properties of a section.
To learn more, visit the Working with Sections documentation article.
Remarks:
PageSetup object contains all the page setup attributes of a section (left margin, bottom margin, paper size, and so on) as properties.
Examples:
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
Methods
| Method | Description |
|---|---|
| clearFormatting() | Resets page setup to default paper size, margins and orientation. |
| fetchInheritedBorderAttr(int key) | |
| getBidi() | Specifies that this section contains bidirectional (complex scripts) text. |
| getBorderAlwaysInFront() | Specifies where the page border is positioned relative to intersecting texts and objects. |
| getBorderAppliesTo() | Specifies which pages the page border is printed on. |
| getBorderDistanceFrom() | Gets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. |
| getBorderSurroundsFooter() | Specifies whether the page border includes or excludes the footer. |
| getBorderSurroundsHeader() | Specifies whether the page border includes or excludes the header. |
| getBorders() | Gets a collection of the page borders. |
| getBottomMargin() | Gets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. |
| getChapterPageSeparator() | Gets the separator character that appears between the chapter number and the page number. |
| getCharactersPerLine() | Gets the number of characters per line in the document grid. |
| getDifferentFirstPageHeaderFooter() | True if a different header or footer is used on the first page. |
| getDirectBorderAttr(int key) | |
| getEndnoteOptions() | Provides options that control numbering and positioning of endnotes in this section. |
| getFirstPageTray() | Gets the paper tray (bin) to use for the first page of a section. |
| getFooterDistance() | Gets the distance (in points) between the footer and the bottom of the page. |
| getFootnoteOptions() | Provides options that control numbering and positioning of footnotes in this section. |
| getGutter() | Gets the amount of extra space added to the margin for document binding. |
| getHeaderDistance() | Gets the distance (in points) between the header and the top of the page. |
| getHeadingLevelForChapter() | Gets the heading level style that is applied to the chapter titles in the document. |
| getLayoutMode() | Gets the layout mode of this section. |
| getLeftMargin() | Gets the distance (in points) between the left edge of the page and the left boundary of the body text. |
| getLineNumberCountBy() | Gets the numeric increment for line numbers. |
| getLineNumberDistanceFromText() | Gets distance between the right edge of line numbers and the left edge of the document. |
| getLineNumberRestartMode() | Gets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. |
| getLineStartingNumber() | Gets the starting line number. |
| getLinesPerPage() | Gets the number of lines per page in the document grid. |
| getMargins() | Gets preset Margins of the page. |
| getMultiplePages() | For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet. |
| getOddAndEvenPagesHeaderFooter() | True if the document has different headers and footers for odd-numbered and even-numbered pages. |
| getOrientation() | Gets the orientation of the page. |
| getOtherPagesTray() | Gets the paper tray (bin) to be used for all but the first page of a section. |
| getPageHeight() | Gets the height of the page in points. |
| getPageNumberStyle() | Gets the page number format. |
| getPageStartingNumber() | Gets the starting page number of the section. |
| getPageWidth() | Gets the width of the page in points. |
| getPaperSize() | Gets the paper size. |
| getRestartPageNumbering() | True if page numbering restarts at the beginning of the section. |
| getRightMargin() | Gets the distance (in points) between the right edge of the page and the right boundary of the body text. |
| getRtlGutter() | Gets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language. |
| getSectionStart() | Gets the type of section break for the specified object. |
| getSheetsPerBooklet() | Gets the number of pages to be included in each booklet. |
| getSuppressEndnotes() | True if endnotes are printed at the end of the next section that doesn’t suppress endnotes. |
| getTextColumns() | Returns a collection that represents the set of text columns. |
| getTextOrientation() | Allows to specify getTextOrientation() / setTextOrientation(int) for the whole page. |
| getTopMargin() | Gets the distance (in points) between the top edge of the page and the top boundary of the body text. |
| getVerticalAlignment() | Gets the vertical alignment of text on each page in a document or section. |
| setBidi(boolean value) | Specifies that this section contains bidirectional (complex scripts) text. |
| setBorderAlwaysInFront(boolean value) | Specifies where the page border is positioned relative to intersecting texts and objects. |
| setBorderAppliesTo(int value) | Specifies which pages the page border is printed on. |
| setBorderAttr(int key, Object value) | |
| setBorderDistanceFrom(int value) | Sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. |
| setBorderSurroundsFooter(boolean value) | Specifies whether the page border includes or excludes the footer. |
| setBorderSurroundsHeader(boolean value) | Specifies whether the page border includes or excludes the header. |
| setBottomMargin(double value) | Sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. |
| setChapterPageSeparator(int value) | Sets the separator character that appears between the chapter number and the page number. |
| setCharactersPerLine(int value) | Sets the number of characters per line in the document grid. |
| setDifferentFirstPageHeaderFooter(boolean value) | True if a different header or footer is used on the first page. |
| setFirstPageTray(int value) | Sets the paper tray (bin) to use for the first page of a section. |
| setFooterDistance(double value) | Sets the distance (in points) between the footer and the bottom of the page. |
| setGutter(double value) | Sets the amount of extra space added to the margin for document binding. |
| setHeaderDistance(double value) | Sets the distance (in points) between the header and the top of the page. |
| setHeadingLevelForChapter(int value) | Sets the heading level style that is applied to the chapter titles in the document. |
| setLayoutMode(int value) | Sets the layout mode of this section. |
| setLeftMargin(double value) | Sets the distance (in points) between the left edge of the page and the left boundary of the body text. |
| setLineNumberCountBy(int value) | Sets the numeric increment for line numbers. |
| setLineNumberDistanceFromText(double value) | Sets distance between the right edge of line numbers and the left edge of the document. |
| setLineNumberRestartMode(int value) | Sets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. |
| setLineStartingNumber(int value) | Sets the starting line number. |
| setLinesPerPage(int value) | Sets the number of lines per page in the document grid. |
| setMargins(int value) | Sets preset Margins of the page. |
| setMultiplePages(int value) | For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet. |
| setOddAndEvenPagesHeaderFooter(boolean value) | True if the document has different headers and footers for odd-numbered and even-numbered pages. |
| setOrientation(int value) | Sets the orientation of the page. |
| setOtherPagesTray(int value) | Sets the paper tray (bin) to be used for all but the first page of a section. |
| setPageHeight(double value) | Sets the height of the page in points. |
| setPageNumberStyle(int value) | Sets the page number format. |
| setPageStartingNumber(int value) | Sets the starting page number of the section. |
| setPageWidth(double value) | Sets the width of the page in points. |
| setPaperSize(int value) | Sets the paper size. |
| setRestartPageNumbering(boolean value) | True if page numbering restarts at the beginning of the section. |
| setRightMargin(double value) | Sets the distance (in points) between the right edge of the page and the right boundary of the body text. |
| setRtlGutter(boolean value) | Sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language. |
| setSectionStart(int value) | Sets the type of section break for the specified object. |
| setSheetsPerBooklet(int value) | Sets the number of pages to be included in each booklet. |
| setSuppressEndnotes(boolean value) | True if endnotes are printed at the end of the next section that doesn’t suppress endnotes. |
| setTextOrientation(int value) | Allows to specify getTextOrientation() / setTextOrientation(int) for the whole page. |
| setTopMargin(double value) | Sets the distance (in points) between the top edge of the page and the top boundary of the body text. |
| setVerticalAlignment(int value) | Sets the vertical alignment of text on each page in a document or section. |
clearFormatting()
public void clearFormatting()
Resets page setup to default paper size, margins and orientation.
Examples:
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
fetchInheritedBorderAttr(int key)
public Object fetchInheritedBorderAttr(int key)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | int |
Returns: java.lang.Object
getBidi()
public boolean getBidi()
Specifies that this section contains bidirectional (complex scripts) text.
Remarks:
When true , the columns in this section are laid out from right to left.
Examples:
Shows how to set the order of text columns in a section.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getTextColumns().setCount(3);
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.write("Column 2.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.write("Column 3.");
// Set the "Bidi" property to "true" to arrange the columns starting from the page's right side.
// The order of the columns will match the direction of the right-to-left text.
// Set the "Bidi" property to "false" to arrange the columns starting from the page's left side.
// The order of the columns will match the direction of the left-to-right text.
pageSetup.setBidi(reverseColumns);
doc.save(getArtifactsDir() + "PageSetup.Bidi.docx");
Returns: boolean - The corresponding boolean value.
getBorderAlwaysInFront()
public boolean getBorderAlwaysInFront()
Specifies where the page border is positioned relative to intersecting texts and objects.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Returns: boolean - The corresponding boolean value.
getBorderAppliesTo()
public int getBorderAppliesTo()
Specifies which pages the page border is printed on.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Returns: int - The corresponding int value. The returned value is one of PageBorderAppliesTo constants.
getBorderDistanceFrom()
public int getBorderDistanceFrom()
Gets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Returns: int - A value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. The returned value is one of PageBorderDistanceFrom constants.
getBorderSurroundsFooter()
public boolean getBorderSurroundsFooter()
Specifies whether the page border includes or excludes the footer.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to apply a border to the page and header/footer.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world! This is the main body text.");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("This is the header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("This is the footer.");
builder.moveToDocumentEnd();
// Insert a blue double-line border.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE);
pageSetup.getBorders().setColor(Color.BLUE);
// A section's PageSetup object has "BorderSurroundsHeader" and "BorderSurroundsFooter" flags that determine
// whether a page border surrounds the main body text, also includes the header or footer, respectively.
// Set the "BorderSurroundsHeader" flag to "true" to surround the header with our border,
// and then set the "BorderSurroundsFooter" flag to leave the footer outside of the border.
pageSetup.setBorderSurroundsHeader(true);
pageSetup.setBorderSurroundsFooter(false);
doc.save(getArtifactsDir() + "PageSetup.PageBorder.docx");
Returns: boolean - The corresponding boolean value.
getBorderSurroundsHeader()
public boolean getBorderSurroundsHeader()
Specifies whether the page border includes or excludes the header.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to apply a border to the page and header/footer.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world! This is the main body text.");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("This is the header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("This is the footer.");
builder.moveToDocumentEnd();
// Insert a blue double-line border.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE);
pageSetup.getBorders().setColor(Color.BLUE);
// A section's PageSetup object has "BorderSurroundsHeader" and "BorderSurroundsFooter" flags that determine
// whether a page border surrounds the main body text, also includes the header or footer, respectively.
// Set the "BorderSurroundsHeader" flag to "true" to surround the header with our border,
// and then set the "BorderSurroundsFooter" flag to leave the footer outside of the border.
pageSetup.setBorderSurroundsHeader(true);
pageSetup.setBorderSurroundsFooter(false);
doc.save(getArtifactsDir() + "PageSetup.PageBorder.docx");
Returns: boolean - The corresponding boolean value.
getBorders()
public BorderCollection getBorders()
Gets a collection of the page borders.
Examples:
Shows how to create green wavy page border with a shadow.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE_WAVE);
pageSetup.getBorders().setLineWidth(2.0);
pageSetup.getBorders().setColor(Color.GREEN);
pageSetup.getBorders().setDistanceFromText(24.0);
pageSetup.getBorders().setShadow(true);
doc.save(getArtifactsDir() + "PageSetup.PageBorders.docx");
Returns: BorderCollection - A collection of the page borders.
getBottomMargin()
public double getBottomMargin()
Gets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
getChapterPageSeparator()
public int getChapterPageSeparator()
Gets the separator character that appears between the chapter number and the page number.
Remarks:
Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied.
Examples:
Shows how to work with page chapters.
Document doc = new Document(getMyDir() + "Big document.docx");
PageSetup pageSetup = doc.getFirstSection().getPageSetup();
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
pageSetup.setChapterPageSeparator(com.aspose.words.ChapterPageSeparator.COLON);
pageSetup.setHeadingLevelForChapter(1);
Returns: int - The separator character that appears between the chapter number and the page number. The returned value is one of ChapterPageSeparator constants.
getCharactersPerLine()
public int getCharactersPerLine()
Gets the number of characters per line in the document grid.
Remarks:
Minimum value of the property is 1. Maximum value depends on page width and font size of the Normal style. Minimum character pitch is 90 percent of the font size. For example, maximum number of characters per line of a Letter page with one-inch margins is 43.
By default, the property has a value, on which character pitch equals to font size of the Normal style.
Examples:
Shows how to specify a for the number of characters that each line may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of characters per line in this section.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.GRID);
builder.getPageSetup().setCharactersPerLine(10);
// The number of characters also depends on the size of the font.
doc.getStyles().get("Normal").getFont().setSize(20.0);
Assert.assertEquals(8, doc.getFirstSection().getPageSetup().getCharactersPerLine());
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
doc.save(getArtifactsDir() + "PageSetup.CharactersPerLine.docx");
Returns: int - The number of characters per line in the document grid.
getDifferentFirstPageHeaderFooter()
public boolean getDifferentFirstPageHeaderFooter()
True if a different header or footer is used on the first page.
Examples:
Shows how to create headers and footers in a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first, even and odd pages.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);
// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for all other pages");
builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page3");
doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");
Shows how to enable or disable primary headers/footers.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Below are two types of header/footers.
// 1 - The "First" header/footer, which appears on the first page of the section.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.writeln("First page header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_FIRST);
builder.writeln("First page footer.");
// 2 - The "Primary" header/footer, which appears on every page in the section.
// We can override the primary header/footer by a first and an even page header/footer.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.writeln("Primary header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.writeln("Primary footer.");
builder.moveToSection(0);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Each section has a "PageSetup" object that specifies page appearance-related properties
// such as orientation, size, and borders.
// Set the "DifferentFirstPageHeaderFooter" property to "true" to apply the first header/footer to the first page.
// Set the "DifferentFirstPageHeaderFooter" property to "false"
// to make the first page display the primary header/footer.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(differentFirstPageHeaderFooter);
doc.save(getArtifactsDir() + "PageSetup.DifferentFirstPageHeaderFooter.docx");
Shows how to track the order in which a text replacement operation traverses nodes.
public void order(boolean differentFirstPageHeaderFooter) throws Exception {
Document doc = new Document(getMyDir() + "Header and footer types.docx");
Section firstPageSection = doc.getFirstSection();
ReplaceLog logger = new ReplaceLog();
FindReplaceOptions options = new FindReplaceOptions();
{
options.setReplacingCallback(logger);
}
// Using a different header/footer for the first page will affect the search order.
firstPageSection.getPageSetup().setDifferentFirstPageHeaderFooter(differentFirstPageHeaderFooter);
doc.getRange().replace(Pattern.compile("(header|footer)"), "", options);
if (differentFirstPageHeaderFooter)
Assert.assertEquals("First headerFirst footerSecond headerSecond footerThird headerThird footer",
logger.Text().replace("\r", ""));
else
Assert.assertEquals("Third headerFirst headerThird footerFirst footerSecond headerSecond footer",
logger.Text().replace("\r", ""));
}
public static Object[][] orderDataProvider() throws Exception {
return new Object[][]
{
{false},
{true},
};
}
///
/// During a find-and-replace operation, records the contents of every node that has text that the operation 'finds',
/// in the state it is in before the replacement takes place.
/// This will display the order in which the text replacement operation traverses nodes.
///
private static class ReplaceLog implements IReplacingCallback {
public int replacing(ReplacingArgs args) {
mTextBuilder.append(args.getMatchNode().getText());
return ReplaceAction.SKIP;
}
public String Text() {
return mTextBuilder.toString();
}
private final StringBuilder mTextBuilder = new StringBuilder();
}
Returns: boolean - The corresponding boolean value.
getDirectBorderAttr(int key)
public Object getDirectBorderAttr(int key)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | int |
Returns: java.lang.Object
getEndnoteOptions()
public EndnoteOptions getEndnoteOptions()
Provides options that control numbering and positioning of endnotes in this section.
Examples:
Shows how to configure options affecting footnotes/endnotes in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote reference text.");
// Configure all footnotes in the first section to restart the numbering from 1
// at each new page and display themselves directly beneath the text on every page.
FootnoteOptions footnoteOptions = doc.getSections().get(0).getPageSetup().getFootnoteOptions();
footnoteOptions.setPosition(FootnotePosition.BENEATH_TEXT);
footnoteOptions.setRestartRule(FootnoteNumberingRule.RESTART_PAGE);
footnoteOptions.setStartNumber(1);
builder.write(" Hello again.");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Endnote reference text.");
// Configure all endnotes in the first section to maintain a continuous count throughout the section,
// starting from 1. Also, set them all to appear collected at the end of the document.
EndnoteOptions endnoteOptions = doc.getSections().get(0).getPageSetup().getEndnoteOptions();
endnoteOptions.setPosition(EndnotePosition.END_OF_DOCUMENT);
endnoteOptions.setRestartRule(FootnoteNumberingRule.CONTINUOUS);
endnoteOptions.setStartNumber(1);
doc.save(getArtifactsDir() + "PageSetup.FootnoteOptions.docx");
Returns: EndnoteOptions - The corresponding EndnoteOptions value.
getFirstPageTray()
public int getFirstPageTray()
Gets the paper tray (bin) to use for the first page of a section. The value is implementation (printer) specific.
Examples:
Shows how to set up printing using different printer trays for different paper sizes.
Document doc = new Document();
/// Choose the default printer to be used for printing this document.
PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
Media[] trays = (Media[]) printService.getSupportedAttributeValues(Media.class, null, null);
// This is the tray we will use for pages in the "A4" paper size.
int printerTrayForA4 = trays[0].getValue();
// This is the tray we will use for pages in the "Letter" paper size.
int printerTrayForLetter = trays[1].getValue();
// Modify the PageSettings object of this section to get Microsoft Word to instruct the printer
// to use one of the trays we identified above, depending on this section's paper size.
for (Section section : doc.getSections()) {
if (section.getPageSetup().getPaperSize() == PaperSize.LETTER) {
section.getPageSetup().setFirstPageTray(printerTrayForLetter);
section.getPageSetup().setOtherPagesTray(printerTrayForLetter);
} else if (section.getPageSetup().getPaperSize() == PaperSize.A4) {
section.getPageSetup().setFirstPageTray(printerTrayForA4);
section.getPageSetup().setOtherPagesTray(printerTrayForA4);
}
}
Returns: int - The paper tray (bin) to use for the first page of a section.
getFooterDistance()
public double getFooterDistance()
Gets the distance (in points) between the footer and the bottom of the page.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the footer and the bottom of the page.
getFootnoteOptions()
public FootnoteOptions getFootnoteOptions()
Provides options that control numbering and positioning of footnotes in this section.
Examples:
Shows how to configure options affecting footnotes/endnotes in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Hello world!");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote reference text.");
// Configure all footnotes in the first section to restart the numbering from 1
// at each new page and display themselves directly beneath the text on every page.
FootnoteOptions footnoteOptions = doc.getSections().get(0).getPageSetup().getFootnoteOptions();
footnoteOptions.setPosition(FootnotePosition.BENEATH_TEXT);
footnoteOptions.setRestartRule(FootnoteNumberingRule.RESTART_PAGE);
footnoteOptions.setStartNumber(1);
builder.write(" Hello again.");
builder.insertFootnote(FootnoteType.FOOTNOTE, "Endnote reference text.");
// Configure all endnotes in the first section to maintain a continuous count throughout the section,
// starting from 1. Also, set them all to appear collected at the end of the document.
EndnoteOptions endnoteOptions = doc.getSections().get(0).getPageSetup().getEndnoteOptions();
endnoteOptions.setPosition(EndnotePosition.END_OF_DOCUMENT);
endnoteOptions.setRestartRule(FootnoteNumberingRule.CONTINUOUS);
endnoteOptions.setStartNumber(1);
doc.save(getArtifactsDir() + "PageSetup.FootnoteOptions.docx");
Returns: FootnoteOptions - The corresponding FootnoteOptions value.
getGutter()
public double getGutter()
Gets the amount of extra space added to the margin for document binding.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Returns: double - The amount of extra space added to the margin for document binding.
getHeaderDistance()
public double getHeaderDistance()
Gets the distance (in points) between the header and the top of the page.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the header and the top of the page.
getHeadingLevelForChapter()
public int getHeadingLevelForChapter()
Gets the heading level style that is applied to the chapter titles in the document.
Remarks:
Can be a number from 0 through 9. 0 means no chapter number if applied to page number.
Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied.
Examples:
Shows how to work with page chapters.
Document doc = new Document(getMyDir() + "Big document.docx");
PageSetup pageSetup = doc.getFirstSection().getPageSetup();
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
pageSetup.setChapterPageSeparator(com.aspose.words.ChapterPageSeparator.COLON);
pageSetup.setHeadingLevelForChapter(1);
Returns: int - The heading level style that is applied to the chapter titles in the document.
getLayoutMode()
public int getLayoutMode()
Gets the layout mode of this section.
Examples:
Shows how to specify a limit for the number of lines that each page may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of lines per page in this section.
// A large enough font size will push some lines down onto the next page to avoid overlapping characters.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.LINE_GRID);
builder.getPageSetup().setLinesPerPage(15);
builder.getParagraphFormat().setSnapToGrid(true);
for (int i = 0; i < 30; i++)
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ");
doc.save(getArtifactsDir() + "PageSetup.LinesPerPage.docx");
Shows how to specify a for the number of characters that each line may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of characters per line in this section.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.GRID);
builder.getPageSetup().setCharactersPerLine(10);
// The number of characters also depends on the size of the font.
doc.getStyles().get("Normal").getFont().setSize(20.0);
Assert.assertEquals(8, doc.getFirstSection().getPageSetup().getCharactersPerLine());
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
doc.save(getArtifactsDir() + "PageSetup.CharactersPerLine.docx");
Returns: int - The layout mode of this section. The returned value is one of SectionLayoutMode constants.
getLeftMargin()
public double getLeftMargin()
Gets the distance (in points) between the left edge of the page and the left boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the left edge of the page and the left boundary of the body text.
getLineNumberCountBy()
public int getLineNumberCountBy()
Gets the numeric increment for line numbers.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Returns: int - The numeric increment for line numbers.
getLineNumberDistanceFromText()
public double getLineNumberDistanceFromText()
Gets distance between the right edge of line numbers and the left edge of the document.
Remarks:
Set this property to zero for automatic distance between the line numbers and text of the document.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Returns: double - Distance between the right edge of line numbers and the left edge of the document.
getLineNumberRestartMode()
public int getLineNumberRestartMode()
Gets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Returns: int - The way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. The returned value is one of LineNumberRestartMode constants.
getLineStartingNumber()
public int getLineStartingNumber()
Gets the starting line number.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Returns: int - The starting line number.
getLinesPerPage()
public int getLinesPerPage()
Gets the number of lines per page in the document grid.
Remarks:
Minimum value of the property is 1. Maximum value depends on page height and font size of the Normal style. Minimum line pitch is 136 percent of the font size. For example, maximum number of lines per page of a Letter page with one-inch margins is 39.
By default, the property has a value, on which line pitch is in 1.5 times greater than font size of the Normal style.
Examples:
Shows how to specify a limit for the number of lines that each page may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of lines per page in this section.
// A large enough font size will push some lines down onto the next page to avoid overlapping characters.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.LINE_GRID);
builder.getPageSetup().setLinesPerPage(15);
builder.getParagraphFormat().setSnapToGrid(true);
for (int i = 0; i < 30; i++)
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ");
doc.save(getArtifactsDir() + "PageSetup.LinesPerPage.docx");
Returns: int - The number of lines per page in the document grid.
getMargins()
public int getMargins()
Gets preset Margins of the page.
Examples:
Shows when to recalculate the page layout of the document.
Document doc = new Document(getMyDir() + "Rendering.docx");
// Saving a document to PDF, to an image, or printing for the first time will automatically
// cache the layout of the document within its pages.
doc.save(getArtifactsDir() + "Document.UpdatePageLayout.1.pdf");
// Modify the document in some way.
doc.getStyles().get("Normal").getFont().setSize(6.0);
doc.getSections().get(0).getPageSetup().setOrientation(Orientation.LANDSCAPE);
doc.getSections().get(0).getPageSetup().setMargins(Margins.MIRRORED);
// In the current version of Aspose.Words, modifying the document does not automatically rebuild
// the cached page layout. If we wish for the cached layout
// to stay up to date, we will need to update it manually.
doc.updatePageLayout();
doc.save(getArtifactsDir() + "Document.UpdatePageLayout.2.pdf");
Returns: int - Preset Margins of the page. The returned value is one of Margins constants.
getMultiplePages()
public int getMultiplePages()
For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Returns: int - The corresponding int value. The returned value is one of MultiplePagesType constants.
getOddAndEvenPagesHeaderFooter()
public boolean getOddAndEvenPagesHeaderFooter()
True if the document has different headers and footers for odd-numbered and even-numbered pages.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to create headers and footers in a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first, even and odd pages.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);
// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for all other pages");
builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page3");
doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");
Shows how to enable or disable even page headers/footers.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Below are two types of header/footers.
// 1 - The "Primary" header/footer, which appears on every page in the section.
// We can override the primary header/footer by a first and an even page header/footer.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.writeln("Primary header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.writeln("Primary footer.");
// 2 - The "Even" header/footer, which appears on every even page of this section.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.writeln("Even page header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_EVEN);
builder.writeln("Even page footer.");
builder.moveToSection(0);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Each section has a "PageSetup" object that specifies page appearance-related properties
// such as orientation, size, and borders.
// Set the "OddAndEvenPagesHeaderFooter" property to "true"
// to display the even page header/footer on even pages.
// Set the "OddAndEvenPagesHeaderFooter" property to "false"
// to display the primary header/footer on even pages.
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(oddAndEvenPagesHeaderFooter);
doc.save(getArtifactsDir() + "PageSetup.OddAndEvenPagesHeaderFooter.docx");
Returns: boolean - The corresponding boolean value.
getOrientation()
public int getOrientation()
Gets the orientation of the page.
Remarks:
Changing getOrientation() / setOrientation(int) swaps getPageWidth() / setPageWidth(double) and getPageHeight() / setPageHeight(double).
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
Returns: int - The orientation of the page. The returned value is one of Orientation constants.
getOtherPagesTray()
public int getOtherPagesTray()
Gets the paper tray (bin) to be used for all but the first page of a section. The value is implementation (printer) specific.
Examples:
Shows how to set up printing using different printer trays for different paper sizes.
Document doc = new Document();
/// Choose the default printer to be used for printing this document.
PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
Media[] trays = (Media[]) printService.getSupportedAttributeValues(Media.class, null, null);
// This is the tray we will use for pages in the "A4" paper size.
int printerTrayForA4 = trays[0].getValue();
// This is the tray we will use for pages in the "Letter" paper size.
int printerTrayForLetter = trays[1].getValue();
// Modify the PageSettings object of this section to get Microsoft Word to instruct the printer
// to use one of the trays we identified above, depending on this section's paper size.
for (Section section : doc.getSections()) {
if (section.getPageSetup().getPaperSize() == PaperSize.LETTER) {
section.getPageSetup().setFirstPageTray(printerTrayForLetter);
section.getPageSetup().setOtherPagesTray(printerTrayForLetter);
} else if (section.getPageSetup().getPaperSize() == PaperSize.A4) {
section.getPageSetup().setFirstPageTray(printerTrayForA4);
section.getPageSetup().setOtherPagesTray(printerTrayForA4);
}
}
Returns: int - The paper tray (bin) to be used for all but the first page of a section.
getPageHeight()
public double getPageHeight()
Gets the height of the page in points.
Examples:
Shows how to insert an image, and use it as a watermark.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert the image into the header so that it will be visible on every page.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
Shape shape = builder.insertImage(getImageDir() + "Transparent background logo.png");
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
// Place the image at the center of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2.0);
shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2.0);
doc.save(getArtifactsDir() + "DocumentBuilder.InsertWatermark.docx");
Returns: double - The height of the page in points.
getPageNumberStyle()
public int getPageNumberStyle()
Gets the page number format.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Returns: int - The page number format. The returned value is one of NumberStyle constants.
getPageStartingNumber()
public int getPageStartingNumber()
Gets the starting page number of the section.
Remarks:
The getRestartPageNumbering() / setRestartPageNumbering(boolean) property, if set to false , will override the getPageStartingNumber() / setPageStartingNumber(int) property so that page numbering can continue from the previous section.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Returns: int - The starting page number of the section.
getPageWidth()
public double getPageWidth()
Gets the width of the page in points.
Examples:
Shows how to insert an image, and use it as a watermark.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert the image into the header so that it will be visible on every page.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
Shape shape = builder.insertImage(getImageDir() + "Transparent background logo.png");
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
// Place the image at the center of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2.0);
shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2.0);
doc.save(getArtifactsDir() + "DocumentBuilder.InsertWatermark.docx");
Shows how to insert a floating image, and specify its position and size.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
shape.setWrapType(WrapType.NONE);
// Configure the shape's "RelativeHorizontalPosition" property to treat the value of the "Left" property
// as the shape's horizontal distance, in points, from the left side of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
// Set the shape's horizontal distance from the left side of the page to 100.
shape.setLeft(100.0);
// Use the "RelativeVerticalPosition" property in a similar way to position the shape 80pt below the top of the page.
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setTop(80.0);
// Set the shape's height, which will automatically scale the width to preserve dimensions.
shape.setHeight(125.0);
Assert.assertEquals(125.0d, shape.getWidth());
// The "Bottom" and "Right" properties contain the bottom and right edges of the image.
Assert.assertEquals(shape.getTop() + shape.getHeight(), shape.getBottom());
Assert.assertEquals(shape.getLeft() + shape.getWidth(), shape.getRight());
doc.save(getArtifactsDir() + "Image.CreateFloatingPositionSize.docx");
Returns: double - The width of the page in points.
getPaperSize()
public int getPaperSize()
Gets the paper size.
Remarks:
Setting this property updates getPageWidth() / setPageWidth(double) and getPageHeight() / setPageHeight(double) values. Setting this value to PaperSize.CUSTOM does not change existing values.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Shows how to construct an Aspose.Words document by hand.
Document doc = new Document();
// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();
// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
Section section = new Section(doc);
doc.appendChild(section);
// Set some page setup properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);
// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
Body body = new Body(doc);
section.appendChild(body);
// Create a paragraph, set some formatting properties, and then append it as a child to the body.
Paragraph para = new Paragraph(doc);
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
body.appendChild(para);
// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);
Assert.assertEquals("Hello World!", doc.getText().trim());
doc.save(getArtifactsDir() + "Section.CreateManually.docx");
Shows how to set page sizes.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can change the current page's size to a pre-defined size
// by using the "PaperSize" property of this section's PageSetup object.
builder.getPageSetup().setPaperSize(PaperSize.TABLOID);
Assert.assertEquals(792.0d, builder.getPageSetup().getPageWidth());
Assert.assertEquals(1224.0d, builder.getPageSetup().getPageHeight());
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
// Each section has its own PageSetup object. When we use a document builder to make a new section,
// that section's PageSetup object inherits all the previous section's PageSetup object's values.
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
Assert.assertEquals(PaperSize.TABLOID, builder.getPageSetup().getPaperSize());
builder.getPageSetup().setPaperSize(PaperSize.A5);
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
Assert.assertEquals(419.55d, builder.getPageSetup().getPageWidth());
Assert.assertEquals(595.30d, builder.getPageSetup().getPageHeight());
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
// Set a custom size for this section's pages.
builder.getPageSetup().setPageWidth(620.0);
builder.getPageSetup().setPageHeight(480.0);
Assert.assertEquals(PaperSize.CUSTOM, builder.getPageSetup().getPaperSize());
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
doc.save(getArtifactsDir() + "PageSetup.PaperSizes.docx");
Returns: int - The paper size. The returned value is one of PaperSize constants.
getRestartPageNumbering()
public boolean getRestartPageNumbering()
True if page numbering restarts at the beginning of the section.
Remarks:
If set to false , the getRestartPageNumbering() / setRestartPageNumbering(boolean) property will override the getPageStartingNumber() / setPageStartingNumber(int) property so that page numbering can continue from the previous section.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Returns: boolean - The corresponding boolean value.
getRightMargin()
public double getRightMargin()
Gets the distance (in points) between the right edge of the page and the right boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the right edge of the page and the right boundary of the body text.
getRtlGutter()
public boolean getRtlGutter()
Gets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
Examples:
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Returns: boolean - Whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
getSectionStart()
public int getSectionStart()
Gets the type of section break for the specified object.
Examples:
Shows how to construct an Aspose.Words document by hand.
Document doc = new Document();
// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();
// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
Section section = new Section(doc);
doc.appendChild(section);
// Set some page setup properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);
// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
Body body = new Body(doc);
section.appendChild(body);
// Create a paragraph, set some formatting properties, and then append it as a child to the body.
Paragraph para = new Paragraph(doc);
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
body.appendChild(para);
// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);
Assert.assertEquals("Hello World!", doc.getText().trim());
doc.save(getArtifactsDir() + "Section.CreateManually.docx");
Shows how to specify how a new section separates itself from the previous.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("This text is in section 1.");
// Section break types determine how a new section separates itself from the previous section.
// Below are five types of section breaks.
// 1 - Starts the next section on a new page:
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("This text is in section 2.");
Assert.assertEquals(SectionStart.NEW_PAGE, doc.getSections().get(1).getPageSetup().getSectionStart());
// 2 - Starts the next section on the current page:
builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
builder.writeln("This text is in section 3.");
Assert.assertEquals(SectionStart.CONTINUOUS, doc.getSections().get(2).getPageSetup().getSectionStart());
// 3 - Starts the next section on a new even page:
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
builder.writeln("This text is in section 4.");
Assert.assertEquals(SectionStart.EVEN_PAGE, doc.getSections().get(3).getPageSetup().getSectionStart());
// 4 - Starts the next section on a new odd page:
builder.insertBreak(BreakType.SECTION_BREAK_ODD_PAGE);
builder.writeln("This text is in section 5.");
Assert.assertEquals(SectionStart.ODD_PAGE, doc.getSections().get(4).getPageSetup().getSectionStart());
// 5 - Starts the next section on a new column:
TextColumnCollection columns = builder.getPageSetup().getTextColumns();
columns.setCount(2);
builder.insertBreak(BreakType.SECTION_BREAK_NEW_COLUMN);
builder.writeln("This text is in section 6.");
Assert.assertEquals(SectionStart.NEW_COLUMN, doc.getSections().get(5).getPageSetup().getSectionStart());
doc.save(getArtifactsDir() + "PageSetup.SetSectionStart.docx");
Returns: int - The type of section break for the specified object. The returned value is one of SectionStart constants.
getSheetsPerBooklet()
public int getSheetsPerBooklet()
Gets the number of pages to be included in each booklet.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Returns: int - The number of pages to be included in each booklet.
getSuppressEndnotes()
public boolean getSuppressEndnotes()
True if endnotes are printed at the end of the next section that doesn’t suppress endnotes. Suppressed endnotes are printed before the endnotes in that section.
Examples:
Shows how to store endnotes at the end of each section, and modify their positions.
public void suppressEndnotes() throws Exception {
Document doc = new Document();
doc.removeAllChildren();
// By default, a document compiles all endnotes at its end.
Assert.assertEquals(EndnotePosition.END_OF_DOCUMENT, doc.getEndnoteOptions().getPosition());
// We use the "Position" property of the document's "EndnoteOptions" object
// to collect endnotes at the end of each section instead.
doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_SECTION);
insertSectionWithEndnote(doc, "Section 1", "Endnote 1, will stay in section 1");
insertSectionWithEndnote(doc, "Section 2", "Endnote 2, will be pushed down to section 3");
insertSectionWithEndnote(doc, "Section 3", "Endnote 3, will stay in section 3");
// While getting sections to display their respective endnotes, we can set the "SuppressEndnotes" flag
// of a section's "PageSetup" object to "true" to revert to the default behavior and pass its endnotes
// onto the next section.
PageSetup pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setSuppressEndnotes(true);
doc.save(getArtifactsDir() + "PageSetup.SuppressEndnotes.docx");
}
///
/// Append a section with text and an endnote to a document.
///
private static void insertSectionWithEndnote(Document doc, String sectionBodyText, String endnoteText) {
Section section = new Section(doc);
doc.appendChild(section);
Body body = new Body(doc);
section.appendChild(body);
Assert.assertEquals(body.getParentNode(), section);
Paragraph para = new Paragraph(doc);
body.appendChild(para);
Assert.assertEquals(para.getParentNode(), body);
DocumentBuilder builder = new DocumentBuilder(doc);
builder.moveTo(para);
builder.write(sectionBodyText);
builder.insertFootnote(FootnoteType.ENDNOTE, endnoteText);
}
Returns: boolean - The corresponding boolean value.
getTextColumns()
public TextColumnCollection getTextColumns()
Returns a collection that represents the set of text columns.
Examples:
Shows how to create multiple evenly spaced columns in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
TextColumnCollection columns = builder.getPageSetup().getTextColumns();
columns.setSpacing(100.0);
columns.setCount(2);
builder.writeln("Column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.writeln("Column 2.");
doc.save(getArtifactsDir() + "PageSetup.ColumnsSameWidth.docx");
Returns: TextColumnCollection - A collection that represents the set of text columns.
getTextOrientation()
public int getTextOrientation()
Allows to specify getTextOrientation() / setTextOrientation(int) for the whole page. Default value is TextOrientation.HORIZONTAL
Remarks:
This property is only supported for MS Word native formats DOCX, WML, RTF and DOC.
Examples:
Shows how to set text orientation.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world!");
// Set the "TextOrientation" property to "TextOrientation.Upward" to rotate all the text 90 degrees
// to the right so that all left-to-right text now goes top-to-bottom.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setTextOrientation(TextOrientation.UPWARD);
doc.save(getArtifactsDir() + "PageSetup.SetTextOrientation.docx");
Returns: int - The corresponding int value. The returned value is one of TextOrientation constants.
getTopMargin()
public double getTopMargin()
Gets the distance (in points) between the top edge of the page and the top boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Returns: double - The distance (in points) between the top edge of the page and the top boundary of the body text.
getVerticalAlignment()
public int getVerticalAlignment()
Gets the vertical alignment of text on each page in a document or section.
Examples:
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
Returns: int - The vertical alignment of text on each page in a document or section. The returned value is one of PageVerticalAlignment constants.
setBidi(boolean value)
public void setBidi(boolean value)
Specifies that this section contains bidirectional (complex scripts) text.
Remarks:
When true , the columns in this section are laid out from right to left.
Examples:
Shows how to set the order of text columns in a section.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getTextColumns().setCount(3);
DocumentBuilder builder = new DocumentBuilder(doc);
builder.write("Column 1.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.write("Column 2.");
builder.insertBreak(BreakType.COLUMN_BREAK);
builder.write("Column 3.");
// Set the "Bidi" property to "true" to arrange the columns starting from the page's right side.
// The order of the columns will match the direction of the right-to-left text.
// Set the "Bidi" property to "false" to arrange the columns starting from the page's left side.
// The order of the columns will match the direction of the left-to-right text.
pageSetup.setBidi(reverseColumns);
doc.save(getArtifactsDir() + "PageSetup.Bidi.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setBorderAlwaysInFront(boolean value)
public void setBorderAlwaysInFront(boolean value)
Specifies where the page border is positioned relative to intersecting texts and objects.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setBorderAppliesTo(int value)
public void setBorderAppliesTo(int value)
Specifies which pages the page border is printed on.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of PageBorderAppliesTo constants. |
setBorderAttr(int key, Object value)
public void setBorderAttr(int key, Object value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| key | int | |
| value | java.lang.Object |
setBorderDistanceFrom(int value)
public void setBorderDistanceFrom(int value)
Sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds.
Examples:
Shows how to create a wide blue band border at the top of the first page.
Document doc = new Document();
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setBorderAlwaysInFront(false);
pageSetup.setBorderDistanceFrom(PageBorderDistanceFrom.PAGE_EDGE);
pageSetup.setBorderAppliesTo(PageBorderAppliesTo.FIRST_PAGE);
Border border = pageSetup.getBorders().getByBorderType(BorderType.TOP);
border.setLineStyle(LineStyle.SINGLE);
border.setLineWidth(30.0);
border.setColor(Color.BLUE);
border.setDistanceFromText(0.0);
doc.save(getArtifactsDir() + "PageSetup.PageBorderProperties.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | A value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds. The value must be one of PageBorderDistanceFrom constants. |
setBorderSurroundsFooter(boolean value)
public void setBorderSurroundsFooter(boolean value)
Specifies whether the page border includes or excludes the footer.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to apply a border to the page and header/footer.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world! This is the main body text.");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("This is the header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("This is the footer.");
builder.moveToDocumentEnd();
// Insert a blue double-line border.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE);
pageSetup.getBorders().setColor(Color.BLUE);
// A section's PageSetup object has "BorderSurroundsHeader" and "BorderSurroundsFooter" flags that determine
// whether a page border surrounds the main body text, also includes the header or footer, respectively.
// Set the "BorderSurroundsHeader" flag to "true" to surround the header with our border,
// and then set the "BorderSurroundsFooter" flag to leave the footer outside of the border.
pageSetup.setBorderSurroundsHeader(true);
pageSetup.setBorderSurroundsFooter(false);
doc.save(getArtifactsDir() + "PageSetup.PageBorder.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setBorderSurroundsHeader(boolean value)
public void setBorderSurroundsHeader(boolean value)
Specifies whether the page border includes or excludes the header.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to apply a border to the page and header/footer.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world! This is the main body text.");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("This is the header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.write("This is the footer.");
builder.moveToDocumentEnd();
// Insert a blue double-line border.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.getBorders().setLineStyle(LineStyle.DOUBLE);
pageSetup.getBorders().setColor(Color.BLUE);
// A section's PageSetup object has "BorderSurroundsHeader" and "BorderSurroundsFooter" flags that determine
// whether a page border surrounds the main body text, also includes the header or footer, respectively.
// Set the "BorderSurroundsHeader" flag to "true" to surround the header with our border,
// and then set the "BorderSurroundsFooter" flag to leave the footer outside of the border.
pageSetup.setBorderSurroundsHeader(true);
pageSetup.setBorderSurroundsFooter(false);
doc.save(getArtifactsDir() + "PageSetup.PageBorder.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setBottomMargin(double value)
public void setBottomMargin(double value)
Sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the bottom edge of the page and the bottom boundary of the body text. |
setChapterPageSeparator(int value)
public void setChapterPageSeparator(int value)
Sets the separator character that appears between the chapter number and the page number.
Remarks:
Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied.
Examples:
Shows how to work with page chapters.
Document doc = new Document(getMyDir() + "Big document.docx");
PageSetup pageSetup = doc.getFirstSection().getPageSetup();
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
pageSetup.setChapterPageSeparator(com.aspose.words.ChapterPageSeparator.COLON);
pageSetup.setHeadingLevelForChapter(1);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The separator character that appears between the chapter number and the page number. The value must be one of ChapterPageSeparator constants. |
setCharactersPerLine(int value)
public void setCharactersPerLine(int value)
Sets the number of characters per line in the document grid.
Remarks:
Minimum value of the property is 1. Maximum value depends on page width and font size of the Normal style. Minimum character pitch is 90 percent of the font size. For example, maximum number of characters per line of a Letter page with one-inch margins is 43.
By default, the property has a value, on which character pitch equals to font size of the Normal style.
Examples:
Shows how to specify a for the number of characters that each line may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of characters per line in this section.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.GRID);
builder.getPageSetup().setCharactersPerLine(10);
// The number of characters also depends on the size of the font.
doc.getStyles().get("Normal").getFont().setSize(20.0);
Assert.assertEquals(8, doc.getFirstSection().getPageSetup().getCharactersPerLine());
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
doc.save(getArtifactsDir() + "PageSetup.CharactersPerLine.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The number of characters per line in the document grid. |
setDifferentFirstPageHeaderFooter(boolean value)
public void setDifferentFirstPageHeaderFooter(boolean value)
True if a different header or footer is used on the first page.
Examples:
Shows how to create headers and footers in a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first, even and odd pages.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);
// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for all other pages");
builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page3");
doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");
Shows how to enable or disable primary headers/footers.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Below are two types of header/footers.
// 1 - The "First" header/footer, which appears on the first page of the section.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.writeln("First page header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_FIRST);
builder.writeln("First page footer.");
// 2 - The "Primary" header/footer, which appears on every page in the section.
// We can override the primary header/footer by a first and an even page header/footer.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.writeln("Primary header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.writeln("Primary footer.");
builder.moveToSection(0);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Each section has a "PageSetup" object that specifies page appearance-related properties
// such as orientation, size, and borders.
// Set the "DifferentFirstPageHeaderFooter" property to "true" to apply the first header/footer to the first page.
// Set the "DifferentFirstPageHeaderFooter" property to "false"
// to make the first page display the primary header/footer.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(differentFirstPageHeaderFooter);
doc.save(getArtifactsDir() + "PageSetup.DifferentFirstPageHeaderFooter.docx");
Shows how to track the order in which a text replacement operation traverses nodes.
public void order(boolean differentFirstPageHeaderFooter) throws Exception {
Document doc = new Document(getMyDir() + "Header and footer types.docx");
Section firstPageSection = doc.getFirstSection();
ReplaceLog logger = new ReplaceLog();
FindReplaceOptions options = new FindReplaceOptions();
{
options.setReplacingCallback(logger);
}
// Using a different header/footer for the first page will affect the search order.
firstPageSection.getPageSetup().setDifferentFirstPageHeaderFooter(differentFirstPageHeaderFooter);
doc.getRange().replace(Pattern.compile("(header|footer)"), "", options);
if (differentFirstPageHeaderFooter)
Assert.assertEquals("First headerFirst footerSecond headerSecond footerThird headerThird footer",
logger.Text().replace("\r", ""));
else
Assert.assertEquals("Third headerFirst headerThird footerFirst footerSecond headerSecond footer",
logger.Text().replace("\r", ""));
}
public static Object[][] orderDataProvider() throws Exception {
return new Object[][]
{
{false},
{true},
};
}
///
/// During a find-and-replace operation, records the contents of every node that has text that the operation 'finds',
/// in the state it is in before the replacement takes place.
/// This will display the order in which the text replacement operation traverses nodes.
///
private static class ReplaceLog implements IReplacingCallback {
public int replacing(ReplacingArgs args) {
mTextBuilder.append(args.getMatchNode().getText());
return ReplaceAction.SKIP;
}
public String Text() {
return mTextBuilder.toString();
}
private final StringBuilder mTextBuilder = new StringBuilder();
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setFirstPageTray(int value)
public void setFirstPageTray(int value)
Sets the paper tray (bin) to use for the first page of a section. The value is implementation (printer) specific.
Examples:
Shows how to set up printing using different printer trays for different paper sizes.
Document doc = new Document();
/// Choose the default printer to be used for printing this document.
PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
Media[] trays = (Media[]) printService.getSupportedAttributeValues(Media.class, null, null);
// This is the tray we will use for pages in the "A4" paper size.
int printerTrayForA4 = trays[0].getValue();
// This is the tray we will use for pages in the "Letter" paper size.
int printerTrayForLetter = trays[1].getValue();
// Modify the PageSettings object of this section to get Microsoft Word to instruct the printer
// to use one of the trays we identified above, depending on this section's paper size.
for (Section section : doc.getSections()) {
if (section.getPageSetup().getPaperSize() == PaperSize.LETTER) {
section.getPageSetup().setFirstPageTray(printerTrayForLetter);
section.getPageSetup().setOtherPagesTray(printerTrayForLetter);
} else if (section.getPageSetup().getPaperSize() == PaperSize.A4) {
section.getPageSetup().setFirstPageTray(printerTrayForA4);
section.getPageSetup().setOtherPagesTray(printerTrayForA4);
}
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The paper tray (bin) to use for the first page of a section. |
setFooterDistance(double value)
public void setFooterDistance(double value)
Sets the distance (in points) between the footer and the bottom of the page.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the footer and the bottom of the page. |
setGutter(double value)
public void setGutter(double value)
Sets the amount of extra space added to the margin for document binding.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The amount of extra space added to the margin for document binding. |
setHeaderDistance(double value)
public void setHeaderDistance(double value)
Sets the distance (in points) between the header and the top of the page.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the header and the top of the page. |
setHeadingLevelForChapter(int value)
public void setHeadingLevelForChapter(int value)
Sets the heading level style that is applied to the chapter titles in the document.
Remarks:
Can be a number from 0 through 9. 0 means no chapter number if applied to page number.
Before you can create page numbers that include chapter numbers, the document headings must have a numbered outline format applied.
Examples:
Shows how to work with page chapters.
Document doc = new Document(getMyDir() + "Big document.docx");
PageSetup pageSetup = doc.getFirstSection().getPageSetup();
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
pageSetup.setChapterPageSeparator(com.aspose.words.ChapterPageSeparator.COLON);
pageSetup.setHeadingLevelForChapter(1);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The heading level style that is applied to the chapter titles in the document. |
setLayoutMode(int value)
public void setLayoutMode(int value)
Sets the layout mode of this section.
Examples:
Shows how to specify a limit for the number of lines that each page may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of lines per page in this section.
// A large enough font size will push some lines down onto the next page to avoid overlapping characters.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.LINE_GRID);
builder.getPageSetup().setLinesPerPage(15);
builder.getParagraphFormat().setSnapToGrid(true);
for (int i = 0; i < 30; i++)
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ");
doc.save(getArtifactsDir() + "PageSetup.LinesPerPage.docx");
Shows how to specify a for the number of characters that each line may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of characters per line in this section.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.GRID);
builder.getPageSetup().setCharactersPerLine(10);
// The number of characters also depends on the size of the font.
doc.getStyles().get("Normal").getFont().setSize(20.0);
Assert.assertEquals(8, doc.getFirstSection().getPageSetup().getCharactersPerLine());
builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
doc.save(getArtifactsDir() + "PageSetup.CharactersPerLine.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The layout mode of this section. The value must be one of SectionLayoutMode constants. |
setLeftMargin(double value)
public void setLeftMargin(double value)
Sets the distance (in points) between the left edge of the page and the left boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the left edge of the page and the left boundary of the body text. |
setLineNumberCountBy(int value)
public void setLineNumberCountBy(int value)
Sets the numeric increment for line numbers.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The numeric increment for line numbers. |
setLineNumberDistanceFromText(double value)
public void setLineNumberDistanceFromText(double value)
Sets distance between the right edge of line numbers and the left edge of the document.
Remarks:
Set this property to zero for automatic distance between the line numbers and text of the document.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | Distance between the right edge of line numbers and the left edge of the document. |
setLineNumberRestartMode(int value)
public void setLineNumberRestartMode(int value)
Sets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously. The value must be one of LineNumberRestartMode constants. |
setLineStartingNumber(int value)
public void setLineStartingNumber(int value)
Sets the starting line number.
Examples:
Shows how to enable line numbering for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can use the section's PageSetup object to display numbers to the left of the section's text lines.
// This is the same behavior as a List object,
// but it covers the entire section and does not modify the text in any way.
// Our section will restart the numbering on each new page from 1 and display the number,
// if it is a multiple of 3, at 50pt to the left of the line.
PageSetup pageSetup = builder.getPageSetup();
pageSetup.setLineStartingNumber(1);
pageSetup.setLineNumberCountBy(3);
pageSetup.setLineNumberRestartMode(LineNumberRestartMode.RESTART_PAGE);
pageSetup.setLineNumberDistanceFromText(50.0d);
for (int i = 1; i <= 25; i++)
builder.writeln(MessageFormat.format("Line {0}.", i));
// The line counter will skip any paragraph with the "SuppressLineNumbers" flag set to "true".
// This paragraph is on the 15th line, which is a multiple of 3, and thus would normally display a line number.
// The section's line counter will also ignore this line, treat the next line as the 15th,
// and continue the count from that point onward.
doc.getFirstSection().getBody().getParagraphs().get(14).getParagraphFormat().setSuppressLineNumbers(true);
doc.save(getArtifactsDir() + "PageSetup.LineNumbers.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The starting line number. |
setLinesPerPage(int value)
public void setLinesPerPage(int value)
Sets the number of lines per page in the document grid.
Remarks:
Minimum value of the property is 1. Maximum value depends on page height and font size of the Normal style. Minimum line pitch is 136 percent of the font size. For example, maximum number of lines per page of a Letter page with one-inch margins is 39.
By default, the property has a value, on which line pitch is in 1.5 times greater than font size of the Normal style.
Examples:
Shows how to specify a limit for the number of lines that each page may have.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Enable pitching, and then use it to set the number of lines per page in this section.
// A large enough font size will push some lines down onto the next page to avoid overlapping characters.
builder.getPageSetup().setLayoutMode(SectionLayoutMode.LINE_GRID);
builder.getPageSetup().setLinesPerPage(15);
builder.getParagraphFormat().setSnapToGrid(true);
for (int i = 0; i < 30; i++)
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ");
doc.save(getArtifactsDir() + "PageSetup.LinesPerPage.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The number of lines per page in the document grid. |
setMargins(int value)
public void setMargins(int value)
Sets preset Margins of the page.
Examples:
Shows when to recalculate the page layout of the document.
Document doc = new Document(getMyDir() + "Rendering.docx");
// Saving a document to PDF, to an image, or printing for the first time will automatically
// cache the layout of the document within its pages.
doc.save(getArtifactsDir() + "Document.UpdatePageLayout.1.pdf");
// Modify the document in some way.
doc.getStyles().get("Normal").getFont().setSize(6.0);
doc.getSections().get(0).getPageSetup().setOrientation(Orientation.LANDSCAPE);
doc.getSections().get(0).getPageSetup().setMargins(Margins.MIRRORED);
// In the current version of Aspose.Words, modifying the document does not automatically rebuild
// the cached page layout. If we wish for the cached layout
// to stay up to date, we will need to update it manually.
doc.updatePageLayout();
doc.save(getArtifactsDir() + "Document.UpdatePageLayout.2.pdf");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | Preset Margins of the page. The value must be one of Margins constants. |
setMultiplePages(int value)
public void setMultiplePages(int value)
For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of MultiplePagesType constants. |
setOddAndEvenPagesHeaderFooter(boolean value)
public void setOddAndEvenPagesHeaderFooter(boolean value)
True if the document has different headers and footers for odd-numbered and even-numbered pages.
Remarks:
Note, changing this property affects all sections in the document.
Examples:
Shows how to create headers and footers in a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Specify that we want different headers and footers for first, even and odd pages.
builder.getPageSetup().setDifferentFirstPageHeaderFooter(true);
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(true);
// Create the headers, then add three pages to the document to display each header type.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_FIRST);
builder.write("Header for the first page");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.write("Header for even pages");
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.write("Header for all other pages");
builder.moveToSection(0);
builder.writeln("Page1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page3");
doc.save(getArtifactsDir() + "DocumentBuilder.HeadersAndFooters.docx");
Shows how to enable or disable even page headers/footers.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Below are two types of header/footers.
// 1 - The "Primary" header/footer, which appears on every page in the section.
// We can override the primary header/footer by a first and an even page header/footer.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.writeln("Primary header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
builder.writeln("Primary footer.");
// 2 - The "Even" header/footer, which appears on every even page of this section.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_EVEN);
builder.writeln("Even page header.");
builder.moveToHeaderFooter(HeaderFooterType.FOOTER_EVEN);
builder.writeln("Even page footer.");
builder.moveToSection(0);
builder.writeln("Page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3.");
// Each section has a "PageSetup" object that specifies page appearance-related properties
// such as orientation, size, and borders.
// Set the "OddAndEvenPagesHeaderFooter" property to "true"
// to display the even page header/footer on even pages.
// Set the "OddAndEvenPagesHeaderFooter" property to "false"
// to display the primary header/footer on even pages.
builder.getPageSetup().setOddAndEvenPagesHeaderFooter(oddAndEvenPagesHeaderFooter);
doc.save(getArtifactsDir() + "PageSetup.OddAndEvenPagesHeaderFooter.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setOrientation(int value)
public void setOrientation(int value)
Sets the orientation of the page.
Remarks:
Changing getOrientation() / setOrientation(int) swaps getPageWidth() / setPageWidth(double) and getPageHeight() / setPageHeight(double).
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The orientation of the page. The value must be one of Orientation constants. |
setOtherPagesTray(int value)
public void setOtherPagesTray(int value)
Sets the paper tray (bin) to be used for all but the first page of a section. The value is implementation (printer) specific.
Examples:
Shows how to set up printing using different printer trays for different paper sizes.
Document doc = new Document();
/// Choose the default printer to be used for printing this document.
PrintService printService = PrintServiceLookup.lookupDefaultPrintService();
Media[] trays = (Media[]) printService.getSupportedAttributeValues(Media.class, null, null);
// This is the tray we will use for pages in the "A4" paper size.
int printerTrayForA4 = trays[0].getValue();
// This is the tray we will use for pages in the "Letter" paper size.
int printerTrayForLetter = trays[1].getValue();
// Modify the PageSettings object of this section to get Microsoft Word to instruct the printer
// to use one of the trays we identified above, depending on this section's paper size.
for (Section section : doc.getSections()) {
if (section.getPageSetup().getPaperSize() == PaperSize.LETTER) {
section.getPageSetup().setFirstPageTray(printerTrayForLetter);
section.getPageSetup().setOtherPagesTray(printerTrayForLetter);
} else if (section.getPageSetup().getPaperSize() == PaperSize.A4) {
section.getPageSetup().setFirstPageTray(printerTrayForA4);
section.getPageSetup().setOtherPagesTray(printerTrayForA4);
}
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The paper tray (bin) to be used for all but the first page of a section. |
setPageHeight(double value)
public void setPageHeight(double value)
Sets the height of the page in points.
Examples:
Shows how to insert an image, and use it as a watermark.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert the image into the header so that it will be visible on every page.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
Shape shape = builder.insertImage(getImageDir() + "Transparent background logo.png");
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
// Place the image at the center of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2.0);
shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2.0);
doc.save(getArtifactsDir() + "DocumentBuilder.InsertWatermark.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The height of the page in points. |
setPageNumberStyle(int value)
public void setPageNumberStyle(int value)
Sets the page number format.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The page number format. The value must be one of NumberStyle constants. |
setPageStartingNumber(int value)
public void setPageStartingNumber(int value)
Sets the starting page number of the section.
Remarks:
The getRestartPageNumbering() / setRestartPageNumbering(boolean) property, if set to false , will override the getPageStartingNumber() / setPageStartingNumber(int) property so that page numbering can continue from the previous section.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The starting page number of the section. |
setPageWidth(double value)
public void setPageWidth(double value)
Sets the width of the page in points.
Examples:
Shows how to insert an image, and use it as a watermark.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Insert the image into the header so that it will be visible on every page.
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
Shape shape = builder.insertImage(getImageDir() + "Transparent background logo.png");
shape.setWrapType(WrapType.NONE);
shape.setBehindText(true);
// Place the image at the center of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setLeft((builder.getPageSetup().getPageWidth() - shape.getWidth()) / 2.0);
shape.setTop((builder.getPageSetup().getPageHeight() - shape.getHeight()) / 2.0);
doc.save(getArtifactsDir() + "DocumentBuilder.InsertWatermark.docx");
Shows how to insert a floating image, and specify its position and size.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Shape shape = builder.insertImage(getImageDir() + "Logo.jpg");
shape.setWrapType(WrapType.NONE);
// Configure the shape's "RelativeHorizontalPosition" property to treat the value of the "Left" property
// as the shape's horizontal distance, in points, from the left side of the page.
shape.setRelativeHorizontalPosition(RelativeHorizontalPosition.PAGE);
// Set the shape's horizontal distance from the left side of the page to 100.
shape.setLeft(100.0);
// Use the "RelativeVerticalPosition" property in a similar way to position the shape 80pt below the top of the page.
shape.setRelativeVerticalPosition(RelativeVerticalPosition.PAGE);
shape.setTop(80.0);
// Set the shape's height, which will automatically scale the width to preserve dimensions.
shape.setHeight(125.0);
Assert.assertEquals(125.0d, shape.getWidth());
// The "Bottom" and "Right" properties contain the bottom and right edges of the image.
Assert.assertEquals(shape.getTop() + shape.getHeight(), shape.getBottom());
Assert.assertEquals(shape.getLeft() + shape.getWidth(), shape.getRight());
doc.save(getArtifactsDir() + "Image.CreateFloatingPositionSize.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The width of the page in points. |
setPaperSize(int value)
public void setPaperSize(int value)
Sets the paper size.
Remarks:
Setting this property updates getPageWidth() / setPageWidth(double) and getPageHeight() / setPageHeight(double) values. Setting this value to PaperSize.CUSTOM does not change existing values.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Shows how to construct an Aspose.Words document by hand.
Document doc = new Document();
// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();
// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
Section section = new Section(doc);
doc.appendChild(section);
// Set some page setup properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);
// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
Body body = new Body(doc);
section.appendChild(body);
// Create a paragraph, set some formatting properties, and then append it as a child to the body.
Paragraph para = new Paragraph(doc);
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
body.appendChild(para);
// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);
Assert.assertEquals("Hello World!", doc.getText().trim());
doc.save(getArtifactsDir() + "Section.CreateManually.docx");
Shows how to set page sizes.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// We can change the current page's size to a pre-defined size
// by using the "PaperSize" property of this section's PageSetup object.
builder.getPageSetup().setPaperSize(PaperSize.TABLOID);
Assert.assertEquals(792.0d, builder.getPageSetup().getPageWidth());
Assert.assertEquals(1224.0d, builder.getPageSetup().getPageHeight());
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
// Each section has its own PageSetup object. When we use a document builder to make a new section,
// that section's PageSetup object inherits all the previous section's PageSetup object's values.
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
Assert.assertEquals(PaperSize.TABLOID, builder.getPageSetup().getPaperSize());
builder.getPageSetup().setPaperSize(PaperSize.A5);
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
Assert.assertEquals(419.55d, builder.getPageSetup().getPageWidth());
Assert.assertEquals(595.30d, builder.getPageSetup().getPageHeight());
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
// Set a custom size for this section's pages.
builder.getPageSetup().setPageWidth(620.0);
builder.getPageSetup().setPageHeight(480.0);
Assert.assertEquals(PaperSize.CUSTOM, builder.getPageSetup().getPaperSize());
builder.writeln(MessageFormat.format("This page is {0}x{1}.", builder.getPageSetup().getPageWidth(), builder.getPageSetup().getPageHeight()));
doc.save(getArtifactsDir() + "PageSetup.PaperSizes.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The paper size. The value must be one of PaperSize constants. |
setRestartPageNumbering(boolean value)
public void setRestartPageNumbering(boolean value)
True if page numbering restarts at the beginning of the section.
Remarks:
If set to false , the getRestartPageNumbering() / setRestartPageNumbering(boolean) property will override the getPageStartingNumber() / setPageStartingNumber(int) property so that page numbering can continue from the previous section.
Examples:
Shows how to set up page numbering in a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Section 1, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 1, page 3.");
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("Section 2, page 1.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 2.");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Section 2, page 3.");
// Move the document builder to the first section's primary header,
// which every page in that section will display.
builder.moveToSection(0);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
// Insert a PAGE field, which will display the number of the current page.
builder.write("Page ");
builder.insertField("PAGE", "");
// Configure the section to have the page count that PAGE fields display start from 5.
// Also, configure all PAGE fields to display their page numbers using uppercase Roman numerals.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageStartingNumber(5);
pageSetup.setPageNumberStyle(NumberStyle.UPPERCASE_ROMAN);
// Create another primary header for the second section, with another PAGE field.
builder.moveToSection(1);
builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write(" - ");
builder.insertField("PAGE", "");
builder.write(" - ");
// Configure the section to have the page count that PAGE fields display start from 10.
// Also, configure all PAGE fields to display their page numbers using Arabic numbers.
pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setPageStartingNumber(10);
pageSetup.setRestartPageNumbering(true);
pageSetup.setPageNumberStyle(NumberStyle.ARABIC);
doc.save(getArtifactsDir() + "PageSetup.PageNumbering.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setRightMargin(double value)
public void setRightMargin(double value)
Sets the distance (in points) between the right edge of the page and the right boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the right edge of the page and the right boundary of the body text. |
setRtlGutter(boolean value)
public void setRtlGutter(boolean value)
Sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
Examples:
Shows how to set gutter margins.
Document doc = new Document();
// Insert text that spans several pages.
DocumentBuilder builder = new DocumentBuilder(doc);
for (int i = 0; i < 6; i++) {
builder.write("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
"sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
builder.insertBreak(BreakType.PAGE_BREAK);
}
// A gutter adds whitespaces to either the left or right page margin,
// which makes up for the center folding of pages in a book encroaching on the page's layout.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
// Determine how much space our pages have for text within the margins and then add an amount to pad a margin.
Assert.assertEquals(468.00d, pageSetup.getPageWidth() - pageSetup.getLeftMargin() - pageSetup.getRightMargin(), 0.01d);
pageSetup.setGutter(100.0d);
// Set the "RtlGutter" property to "true" to place the gutter in a more suitable position for right-to-left text.
pageSetup.setRtlGutter(true);
// Set the "MultiplePages" property to "MultiplePagesType.MirrorMargins" to alternate
// the left/right page side position of margins every page.
pageSetup.setMultiplePages(MultiplePagesType.MIRROR_MARGINS);
doc.save(getArtifactsDir() + "PageSetup.Gutter.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | Whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language. |
setSectionStart(int value)
public void setSectionStart(int value)
Sets the type of section break for the specified object.
Examples:
Shows how to construct an Aspose.Words document by hand.
Document doc = new Document();
// A blank document contains one section, one body and one paragraph.
// Call the "RemoveAllChildren" method to remove all those nodes,
// and end up with a document node with no children.
doc.removeAllChildren();
// This document now has no composite child nodes that we can add content to.
// If we wish to edit it, we will need to repopulate its node collection.
// First, create a new section, and then append it as a child to the root document node.
Section section = new Section(doc);
doc.appendChild(section);
// Set some page setup properties for the section.
section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
section.getPageSetup().setPaperSize(PaperSize.LETTER);
// A section needs a body, which will contain and display all its contents
// on the page between the section's header and footer.
Body body = new Body(doc);
section.appendChild(body);
// Create a paragraph, set some formatting properties, and then append it as a child to the body.
Paragraph para = new Paragraph(doc);
para.getParagraphFormat().setStyleName("Heading 1");
para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
body.appendChild(para);
// Finally, add some content to do the document. Create a run,
// set its appearance and contents, and then append it as a child to the paragraph.
Run run = new Run(doc);
run.setText("Hello World!");
run.getFont().setColor(Color.RED);
para.appendChild(run);
Assert.assertEquals("Hello World!", doc.getText().trim());
doc.save(getArtifactsDir() + "Section.CreateManually.docx");
Shows how to specify how a new section separates itself from the previous.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("This text is in section 1.");
// Section break types determine how a new section separates itself from the previous section.
// Below are five types of section breaks.
// 1 - Starts the next section on a new page:
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
builder.writeln("This text is in section 2.");
Assert.assertEquals(SectionStart.NEW_PAGE, doc.getSections().get(1).getPageSetup().getSectionStart());
// 2 - Starts the next section on the current page:
builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
builder.writeln("This text is in section 3.");
Assert.assertEquals(SectionStart.CONTINUOUS, doc.getSections().get(2).getPageSetup().getSectionStart());
// 3 - Starts the next section on a new even page:
builder.insertBreak(BreakType.SECTION_BREAK_EVEN_PAGE);
builder.writeln("This text is in section 4.");
Assert.assertEquals(SectionStart.EVEN_PAGE, doc.getSections().get(3).getPageSetup().getSectionStart());
// 4 - Starts the next section on a new odd page:
builder.insertBreak(BreakType.SECTION_BREAK_ODD_PAGE);
builder.writeln("This text is in section 5.");
Assert.assertEquals(SectionStart.ODD_PAGE, doc.getSections().get(4).getPageSetup().getSectionStart());
// 5 - Starts the next section on a new column:
TextColumnCollection columns = builder.getPageSetup().getTextColumns();
columns.setCount(2);
builder.insertBreak(BreakType.SECTION_BREAK_NEW_COLUMN);
builder.writeln("This text is in section 6.");
Assert.assertEquals(SectionStart.NEW_COLUMN, doc.getSections().get(5).getPageSetup().getSectionStart());
doc.save(getArtifactsDir() + "PageSetup.SetSectionStart.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The type of section break for the specified object. The value must be one of SectionStart constants. |
setSheetsPerBooklet(int value)
public void setSheetsPerBooklet(int value)
Sets the number of pages to be included in each booklet.
Examples:
Shows how to configure a document that can be printed as a book fold.
Document doc = new Document();
// Insert text that spans 16 pages.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("My Booklet:");
for (int i = 0; i < 15; i++) {
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write(MessageFormat.format("Booklet face #{0}", i));
}
// Configure the first section's "PageSetup" property to print the document in the form of a book fold.
// When we print this document on both sides, we can take the pages to stack them
// and fold them all down the middle at once. The contents of the document will line up into a book fold.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setMultiplePages(MultiplePagesType.BOOK_FOLD_PRINTING);
// We can only specify the number of sheets in multiples of 4.
pageSetup.setSheetsPerBooklet(4);
doc.save(getArtifactsDir() + "PageSetup.Booklet.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The number of pages to be included in each booklet. |
setSuppressEndnotes(boolean value)
public void setSuppressEndnotes(boolean value)
True if endnotes are printed at the end of the next section that doesn’t suppress endnotes. Suppressed endnotes are printed before the endnotes in that section.
Examples:
Shows how to store endnotes at the end of each section, and modify their positions.
public void suppressEndnotes() throws Exception {
Document doc = new Document();
doc.removeAllChildren();
// By default, a document compiles all endnotes at its end.
Assert.assertEquals(EndnotePosition.END_OF_DOCUMENT, doc.getEndnoteOptions().getPosition());
// We use the "Position" property of the document's "EndnoteOptions" object
// to collect endnotes at the end of each section instead.
doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_SECTION);
insertSectionWithEndnote(doc, "Section 1", "Endnote 1, will stay in section 1");
insertSectionWithEndnote(doc, "Section 2", "Endnote 2, will be pushed down to section 3");
insertSectionWithEndnote(doc, "Section 3", "Endnote 3, will stay in section 3");
// While getting sections to display their respective endnotes, we can set the "SuppressEndnotes" flag
// of a section's "PageSetup" object to "true" to revert to the default behavior and pass its endnotes
// onto the next section.
PageSetup pageSetup = doc.getSections().get(1).getPageSetup();
pageSetup.setSuppressEndnotes(true);
doc.save(getArtifactsDir() + "PageSetup.SuppressEndnotes.docx");
}
///
/// Append a section with text and an endnote to a document.
///
private static void insertSectionWithEndnote(Document doc, String sectionBodyText, String endnoteText) {
Section section = new Section(doc);
doc.appendChild(section);
Body body = new Body(doc);
section.appendChild(body);
Assert.assertEquals(body.getParentNode(), section);
Paragraph para = new Paragraph(doc);
body.appendChild(para);
Assert.assertEquals(para.getParentNode(), body);
DocumentBuilder builder = new DocumentBuilder(doc);
builder.moveTo(para);
builder.write(sectionBodyText);
builder.insertFootnote(FootnoteType.ENDNOTE, endnoteText);
}
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The corresponding boolean value. |
setTextOrientation(int value)
public void setTextOrientation(int value)
Allows to specify getTextOrientation() / setTextOrientation(int) for the whole page. Default value is TextOrientation.HORIZONTAL
Remarks:
This property is only supported for MS Word native formats DOCX, WML, RTF and DOC.
Examples:
Shows how to set text orientation.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Hello world!");
// Set the "TextOrientation" property to "TextOrientation.Upward" to rotate all the text 90 degrees
// to the right so that all left-to-right text now goes top-to-bottom.
PageSetup pageSetup = doc.getSections().get(0).getPageSetup();
pageSetup.setTextOrientation(TextOrientation.UPWARD);
doc.save(getArtifactsDir() + "PageSetup.SetTextOrientation.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The corresponding int value. The value must be one of TextOrientation constants. |
setTopMargin(double value)
public void setTopMargin(double value)
Sets the distance (in points) between the top edge of the page and the top boundary of the body text.
Examples:
Shows how to adjust paper size, orientation, margins, along with other settings for a section.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.getPageSetup().setPaperSize(PaperSize.LEGAL);
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setTopMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setBottomMargin(ConvertUtil.inchToPoint(1.0));
builder.getPageSetup().setLeftMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setRightMargin(ConvertUtil.inchToPoint(1.5));
builder.getPageSetup().setHeaderDistance(ConvertUtil.inchToPoint(0.2));
builder.getPageSetup().setFooterDistance(ConvertUtil.inchToPoint(0.2));
builder.writeln("Hello world!");
doc.save(getArtifactsDir() + "PageSetup.PageMargins.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | The distance (in points) between the top edge of the page and the top boundary of the body text. |
setVerticalAlignment(int value)
public void setVerticalAlignment(int value)
Sets the vertical alignment of text on each page in a document or section.
Examples:
Shows how to apply and revert page setup settings to sections in a document.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Modify the page setup properties for the builder's current section and add text.
builder.getPageSetup().setOrientation(Orientation.LANDSCAPE);
builder.getPageSetup().setVerticalAlignment(PageVerticalAlignment.CENTER);
builder.writeln("This is the first section, which landscape oriented with vertically centered text.");
// If we start a new section using a document builder,
// it will inherit the builder's current page setup properties.
builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
Assert.assertEquals(Orientation.LANDSCAPE, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.CENTER, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
// We can revert its page setup properties to their default values using the "ClearFormatting" method.
builder.getPageSetup().clearFormatting();
Assert.assertEquals(Orientation.PORTRAIT, doc.getSections().get(1).getPageSetup().getOrientation());
Assert.assertEquals(PageVerticalAlignment.TOP, doc.getSections().get(1).getPageSetup().getVerticalAlignment());
builder.writeln("This is the second section, which is in default Letter paper size, portrait orientation and top alignment.");
doc.save(getArtifactsDir() + "PageSetup.ClearFormatting.docx");
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The vertical alignment of text on each page in a document or section. The value must be one of PageVerticalAlignment constants. |
