addPageNumber

addPageNumber

BASIC / ADVANCED / PREMIUM

Inserts the current page number into the Word document.

Description
public void addPageNumber()
public void addPageNumber(String type)
public void addPageNumber(String type, OptionsPageNumber options)

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

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

Parameters

type

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

options for numerical or alphabetical types:

Option Type Description
pStyle String Word style to be used. Run parseStyles() method to check all available paragraph styles.
backgroundColor String Hexadecimal color value: FF0000, 000000...
bidi Boolean Sets to true for right to left languages like Hebrew or Arabic.
bold Boolean If true the text will be shown in bold characters.
border String Available values are:
  • none (default)
  • double
  • dashed
  • outset
  • inset
  • threeDEmboss
  • threeDEngrave
borderBottom String Overwrites the general border type for the bottom border of the paragraph.
borderLeft String Overwrites the general border type for the left border of the paragraph.
borderTop String Overwrites the general border type for the top border of the paragraph.
borderRight String Overwrites the general border type for the right border of the paragraph.
borderColor String Hexadecimal color value: FF0000, 000000...
borderBottomColor String Overwrites the general border color for the bottom border of the paragraph.
borderLeftColor String Overwrites the general border color for the left border of the paragraph.
borderTopColor String Overwrites the general border color for the top border of the paragraph.
borderRightColor String Overwrites the general border color for the right border of the paragraph.
borderSpacing Integer Separation between border and text in points.
borderBottomSpacing Integer Overwrites the general border spacing for the bottom border of the paragraph.
borderLeftSpacing Integer Overwrites the general border spacing for the left border of the paragraph.
borderTopSpacing Integer Overwrites the general border spacing for the top border of the paragraph.
borderRightSpacing Integer Overwrites the general border spacing for the right border of the paragraph.
borderWidth Integer Border width in eigths of a point.
borderBottomWidth Integer Overwrites the general border width for the bottom border of the paragraph.
borderLeftWidth Integer Overwrites the general border width for the left border of the paragraph.
borderTopWidth Integer Overwrites the general border width for the top border of the paragraph.
borderRightWidth Integer Overwrites the general border width for the right border of the paragraph.
caps Boolean If true displays text in capital letters.
color String Hexadecimal color value: "FF0000", "000000"...
contextualSpacing String Ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style.
doubleStrikeThrough Boolean If true displays text in doubleStrikeThrough.
em String Emphasis mark type: "none", "dot", "circle", "comma", "underDot".
firstLineIndent Integer First line indentation in twentieths of a point (twips).
font String Font family: "Arial", "Calibri"...
fontSize Integer Font size in points.
hanging Integer Paragraph hanging in twentieths of a point (twips).
headingLevel Integer The heading level if you want this paragraph to be a heading.
italic Boolean If true displays the text in italics.
indentLeft Integer Left margin in points.
indentRight Integer Right margin in points.
keepLines Boolean Keeps (whenever possible) all the current paragraph lines on the same page (default value is false).
keepNext Boolean Keeps (whenever possible) in the same page the current paragraph with next paragraph (default value is false).
lineSpacing Integer 120, 240 (standard), 360, 480... (in twentieths of a point).
pageBreakBefore Boolean If true forces a page break before the paragraph.
position Integer Position value. Positive value for raised and negative value for lowered.
rtl Boolean Sets to true for right to left languages like Hebrew or Arabic.
scaling Integer Scaling value, 100 is the default value.
smallCaps Boolean If true displays text in small capital letters.
spacingBottom Integer Bottom padding in twentieths of a point.
spacingTop Integer Top padding in twentieths of a point.
strikeThrough Boolean If true displays text in strikethrough.
tabPositions ArrayList<HashMap<String, String>> Each entry is a HashMap array with the following keys and values:
  • type can be clear, left (default), center, right, decimal, bar and num.
  • leader can be none (default), dot, hyphen, underscore, heavy and middleDot.
  • position given in twentieths of a point.
textAlign String Text alignment within paragraph. Possible values are: center, right, both and distribute.
textDirection String Text flow direction within a table cell. Possible values are: lrTb, tbRl, btLr, lrTbV, tbRlV and tbLrV.
underline String Underlines text. Possible values are: single, words, double, dotted, dash and wave.
underlineColor String Underlines text with a color: "FF0000", "000000"...
vanish Boolean Uses a vanish style.
widowControl Boolean Prevents Word from printing the last line of a paragraph by itself at the top of the page (widow) or the first line of a paragraph at the bottom of a page (orphan).
wordWrap Boolean Allows line breaking at character level (default value is false).

options for page-of type:

Option Type Description
pStyle String Word style to be used.
textAlign String center, left or right.
Code samples

Example #1

The resulting Word document looks like: