createParagraphStyle

createParagraphStyle

BASIC / ADVANCED / PREMIUM

Creates a new Word paragraph style.

Description
public createParagraphStyle ( string $name [, array $styleOptions = array() ])

This method allows the generation of custom paragraph styles that may be later used in combination with, for example, the addText method.

Parameters

name

A string with the name of the Word style that you are creating.

styleOptions

This is an array including all the available styling options.

Key Type Description
backgroundColor string Hexadecimal value (FFFF00, CCCCCC, ...).
bidi bool Sets to true for right to left languages like Hebrew or Arabic.
bold bool If true the text will be shown in bold characters.
border string Available values are:
  • none (default)
  • double
  • dashed
  • outset
  • inset
  • threeDEmboss
  • threeDEngrave
You can access to the complete list in: Border Styles.
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 int Separation between border and text in points.
borderBottomSpacing int Overwrites the general border spacing for the bottom border of the paragraph.
borderLeftSpacing int Overwrites the general border spacing for the left border of the paragraph.
borderTopSpacing int Overwrites the general border spacing for the top border of the paragraph.
borderRightSpacing int Overwrites the general border spacing for the right border of the paragraph.
borderWidth int Border width in eigths of a point.
borderBottomWidth int Overwrites the general border width for the bottom border of the paragraph.
borderLeftWidth int Overwrites the general border width for the left border of the paragraph.
borderTopWidth int Overwrites the general border width for the top border of the paragraph.
borderRightWidth int Overwrites the general border width for the right border of the paragraph.
caps bool If true displays text in capital letters.
color string Hexadecimal color value: 'FF0000', '000000'...
contextualSpacing bool If true ignores spacing above and below the paragraph whenever the neighbouring paragraphs use the same Word style (false by default).
doubleStrikeThrough bool If true displays text in doubleStrikeThrough.
em string Emphasis mark type: 'none', 'dot', 'circle', 'comma', 'underDot'.
firstLineIndent int First line indentation in twentieths of a point (twips).
font string Font family: 'Arial', Calibri'...
fontSize int Text size in points: 8, 9, 10...
hanging int Paragraph hanging in twentieths of a point (twips).
headingLevel int The heading level if you want this paragraph to be a heading.
indentLeft int Left margin in twips (twentieths of a point).
indentRight int Right margin in twips (twentieths of a point).
italic bool If true displays the text in italics.
keepLines bool Keeps (whenever possible) all the current paragraph lines on the same page.
keepNext bool Keeps (whenever possible) in the same page the current paragraph with next paragraph.
lineSpacing int Separation between lines: 240 (single spacing), 480 (double spacing) and so long so forth.
numberingStyle string Numbering style.
pageBreakBefore bool If true forces a page break before the paragraph.
position int Position value. Positive value for raised and negative value for lowered.
pStyle string Id of the style this paragraph style is based on (it may be retrieved with the parseStyles method).
rtl bool Sets to true for right to left languages like Hebrew or Arabic.
scaling int Scaling value, 100 is the default value.
smallCaps bool If true displays text in small capital letters.
spacingBottom int Bottom padding in twentieths of a point.
spacingTop int Top padding in twentieths of a point.
strikeThrough bool If true displays text in strikethrough.
tabPositions array Each entry is an associative array with the following keys and values:
  • 'type' (string) can be clear, left (default), center, right, decimal, bar and num.
  • 'leader' (string) can be none (default), dot, hyphen, underscore, heavy and middleDot.
  • 'position' (int) given in twentieths of a point.
If there is a tab and the tabPositions array is not defined the standard tab position (default of 708) will be used.
textAlign string Text alignment. Possible values are: 'center', 'right', 'both', 'distribute'.
textDirection string Text flow: lrTb, tbRl, btLr, lrTbV, tbRlV, tbLrV.
underline string Underlines text. Possible values are: 'single', 'words', 'double', 'dotted', 'dash' and 'wave'.
vanish bool Uses a vanish style.
widowControl bool 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 bool Allows line breaking at character level (default value is false).
Code samples

Example #1

The resulting Word document looks like:

Example #2

The resulting Word document looks like: