\PhpOffice\PhpWord\StyleParagraph

Paragraph style

OOXML:

General: alignment, outline level
Indentation: left, right, firstline, hanging
Spacing: before, after, line spacing
Pagination: widow control, keep next, keep line, page break before
Formatting exception: suppress line numbers, don't hyphenate
Textbox options
Tabs
Shading
Borders

OpenOffice:

Indents & spacing
Alignment
Text flow
Outline & numbering
Tabs
Dropcaps
Tabs
Borders
Background

Summary

Methods

Properties

Constants

getBorderSize()
setBorderSize()
getBorderColor()
setBorderColor()
getBorderStyle()
setBorderStyle()
getBorderTopSize()
setBorderTopSize()
getBorderTopColor()
setBorderTopColor()
getBorderTopStyle()
setBorderTopStyle()
getBorderLeftSize()
setBorderLeftSize()
getBorderLeftColor()
setBorderLeftColor()
getBorderLeftStyle()
setBorderLeftStyle()
getBorderRightSize()
setBorderRightSize()
getBorderRightColor()
setBorderRightColor()
getBorderRightStyle()
setBorderRightStyle()
getBorderBottomSize()
setBorderBottomSize()
getBorderBottomColor()
setBorderBottomColor()
getBorderBottomStyle()
setBorderBottomStyle()
hasBorder()
getStyleName()
setStyleName()
getIndex()
setIndex()
isAuto()
setAuto()
getChildStyleValue()
setStyleValue()
setStyleByArray()
setArrayStyle()
getStyleValues()
getAlignment()
setAlignment()
getAlign()
setAlign()
getBasedOn()
setBasedOn()
getNext()
setNext()
getIndentation()
setIndentation()
getIndent()
setIndent()
getHanging()
setHanging()
getSpace()
setSpace()
getSpaceBefore()
setSpaceBefore()
getSpaceAfter()
setSpaceAfter()
getSpacing()
setSpacing()
getSpacingLineRule()
setSpacingLineRule()
getLineHeight()
setLineHeight()
hasWidowControl()
setWidowControl()
isKeepNext()
setKeepNext()
isKeepLines()
setKeepLines()
hasPageBreakBefore()
setPageBreakBefore()
getNumStyle()
setNumStyle()
getNumLevel()
setNumLevel()
getTabs()
setTabs()
getWidowControl()
getKeepNext()
getKeepLines()
getPageBreakBefore()
getShading()
setShading()
hasContextualSpacing()
setContextualSpacing()
isBidi()
setBidi()
getTextAlignment()
setTextAlignment()
hasSuppressAutoHyphens()
setSuppressAutoHyphens()

No public properties found

LINE_HEIGHT

setNonEmptyVal()
setBoolVal()
setNumericVal()
setIntVal()
setFloatVal()
setEnumVal()
setObjectVal()
setPairedVal()

$borderTopSize
$borderTopColor
$borderTopStyle
$borderLeftSize
$borderLeftColor
$borderLeftStyle
$borderRightSize
$borderRightColor
$borderRightStyle
$borderBottomSize
$borderBottomColor
$borderBottomStyle
$styleName
$index
$aliases

N/A

No private methods found

$isAuto
$basedOn
$next
$alignment
$indentation
$spacing
$lineHeight
$widowControl
$keepNext
$keepLines
$pageBreakBefore
$numStyle
$numLevel
$tabs
$shading
$contextualSpacing
$bidi
$textAlignment
$suppressAutoHyphens

N/A

Constants

LINE_HEIGHT

LINE_HEIGHT = 240

Tags

const	int One line height equals 240 twip

Properties

$borderTopSize

$borderTopSize : integer|float

Border Top Size

Type

integer|float

$borderTopColor

$borderTopColor : string

Border Top Color

Type

string

$borderTopStyle

$borderTopStyle : string

Border Top Style

Type

string

$borderLeftSize

$borderLeftSize : integer|float

Border Left Size

Type

integer|float

$borderLeftColor

$borderLeftColor : string

Border Left Color

Type

string

$borderLeftStyle

$borderLeftStyle : string

Border Left Style

Type

string

$borderRightSize

$borderRightSize : integer|float

Border Right Size

Type

integer|float

$borderRightColor

$borderRightColor : string

Border Right Color

Type

string

$borderRightStyle

$borderRightStyle : string

Border Right Style

Type

string

$borderBottomSize

$borderBottomSize : integer|float

Border Bottom Size

Type

integer|float

$borderBottomColor

$borderBottomColor : string

Border Bottom Color

Type

string

$borderBottomStyle

$borderBottomStyle : string

Border Bottom Style

Type

string

$styleName

$styleName : string

Style name

Type

string

$index

$index : integer|null

Index number in Style collection for named style

This number starts from one and defined in Style::setStyleValues()

Type

integer|null

$aliases

$aliases : array

Aliases

Type

array

$isAuto

$isAuto : boolean

Is this an automatic style? (Used primarily in OpenDocument driver)

Type

boolean

Inherited from: \PhpOffice\PhpWord\Style\AbstractStyle

Tags

since	0.11.0

$basedOn

$basedOn : string

Parent style

Type

string

$next

$next : string

Style for next paragraph

Type

string

$alignment

$alignment : string

Type

string

$indentation

$indentation : \PhpOffice\PhpWord\Style\Indentation

Indentation

Type

\PhpOffice\PhpWord\Style\Indentation

$spacing

$spacing : \PhpOffice\PhpWord\Style\Spacing

Spacing

Type

\PhpOffice\PhpWord\Style\Spacing

$lineHeight

$lineHeight : integer

Text line height

Type

integer

$widowControl

$widowControl : boolean

Allow first/last line to display on a separate page

Type

boolean

$keepNext

$keepNext : boolean

Keep paragraph with next paragraph

Type

boolean

$keepLines

$keepLines : boolean

Keep all lines on one page

Type

boolean

$pageBreakBefore

$pageBreakBefore : boolean

Start paragraph on next page

Type

boolean

$numStyle

$numStyle : string

Numbering style name

Type

string

$numLevel

$numLevel : integer

Numbering level

Type

integer

$tabs

$tabs : array<mixed,\PhpOffice\PhpWord\Style\Tab>

Set of Custom Tab Stops

Type

array<mixed,\PhpOffice\PhpWord\Style\Tab>

$shading

$shading : \PhpOffice\PhpWord\Style\Shading

Shading

Type

\PhpOffice\PhpWord\Style\Shading

$contextualSpacing

$contextualSpacing : boolean

Ignore Spacing Above and Below When Using Identical Styles

Type

boolean

$bidi

$bidi : boolean

Right to Left Paragraph Layout

Type

boolean

$textAlignment

$textAlignment : string

Vertical Character Alignment on Line

Type

string

$suppressAutoHyphens

$suppressAutoHyphens : boolean

Suppress hyphenation for paragraph

Type

boolean

Methods

getBorderSize()

getBorderSize() : array<mixed,integer>

Get border size

Returns

array<mixed,integer>

setBorderSize()

setBorderSize(integer|float  $value = null) : self

Set border size

Parameters

integer|float

$value

Returns

self

getBorderColor()

getBorderColor() : array<mixed,string>

Get border color

Returns

array<mixed,string>

setBorderColor()

setBorderColor(string  $value = null) : self

Set border color

Parameters

string

$value

Returns

self

getBorderStyle()

getBorderStyle() : array<mixed,string>

Get border style

Returns

array<mixed,string>

setBorderStyle()

setBorderStyle(string  $value = null) : self

Set border style

Parameters

string

$value

Returns

self

getBorderTopSize()

getBorderTopSize() : integer|float

Get border top size

Returns

integer|float

setBorderTopSize()

setBorderTopSize(integer|float  $value = null) : self

Set border top size

Parameters

integer|float

$value

Returns

self

getBorderTopColor()

getBorderTopColor() : string

Get border top color

Returns

string

setBorderTopColor()

setBorderTopColor(string  $value = null) : self

Set border top color

Parameters

string

$value

Returns

self

getBorderTopStyle()

getBorderTopStyle() : string

Get border top style

Returns

string

setBorderTopStyle()

setBorderTopStyle(string  $value = null) : self

Set border top Style

Parameters

string

$value

Returns

self

getBorderLeftSize()

getBorderLeftSize() : integer|float

Get border left size

Returns

integer|float

setBorderLeftSize()

setBorderLeftSize(integer|float  $value = null) : self

Set border left size

Parameters

integer|float

$value

Returns

self

getBorderLeftColor()

getBorderLeftColor() : string

Get border left color

Returns

string

setBorderLeftColor()

setBorderLeftColor(string  $value = null) : self

Set border left color

Parameters

string

$value

Returns

self

getBorderLeftStyle()

getBorderLeftStyle() : string

Get border left style

Returns

string

setBorderLeftStyle()

setBorderLeftStyle(string  $value = null) : self

Set border left style

Parameters

string

$value

Returns

self

getBorderRightSize()

getBorderRightSize() : integer|float

Get border right size

Returns

integer|float

setBorderRightSize()

setBorderRightSize(integer|float  $value = null) : self

Set border right size

Parameters

integer|float

$value

Returns

self

getBorderRightColor()

getBorderRightColor() : string

Get border right color

Returns

string

setBorderRightColor()

setBorderRightColor(string  $value = null) : self

Set border right color

Parameters

string

$value

Returns

self

getBorderRightStyle()

getBorderRightStyle() : string

Get border right style

Returns

string

setBorderRightStyle()

setBorderRightStyle(string  $value = null) : self

Set border right style

Parameters

string

$value

Returns

self

getBorderBottomSize()

getBorderBottomSize() : integer|float

Get border bottom size

Returns

integer|float

setBorderBottomSize()

setBorderBottomSize(integer|float  $value = null) : self

Set border bottom size

Parameters

integer|float

$value

Returns

self

getBorderBottomColor()

getBorderBottomColor() : string

Get border bottom color

Returns

string

setBorderBottomColor()

setBorderBottomColor(string  $value = null) : self

Set border bottom color

Parameters

string

$value

Returns

self

getBorderBottomStyle()

getBorderBottomStyle() : string

Get border bottom style

Returns

string

setBorderBottomStyle()

setBorderBottomStyle(string  $value = null) : self

Set border bottom style

Parameters

string

$value

Returns

self

hasBorder()

hasBorder() : boolean

Check if any of the border is not null

Returns

boolean

getStyleName()

getStyleName() : string

Get style name

Returns

string

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

string

$value

Returns

self

getIndex()

getIndex() : integer|null

Get index number

Returns

integer|null

setIndex()

setIndex(integer|null  $value = null) : self

Set index number

Parameters

integer|null

$value

Returns

self

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

boolean

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

boolean

$value

Returns

self

getChildStyleValue()

getChildStyleValue(\PhpOffice\PhpWord\Style\AbstractStyle  $substyleObject, string  $substyleProperty) : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`

Parameters

\PhpOffice\PhpWord\Style\AbstractStyle	$substyleObject
string	$substyleProperty

Returns

mixed

Inherited from: \PhpOffice\PhpWord\Style\AbstractStyle

Tags

since	0.12.0

setStyleValue()

setStyleValue(string  $key, mixed  $value) : self

Set Style value

Parameters

string	$key
mixed	$value

Returns

self

setStyleByArray()

setStyleByArray(array  $values = array()) : self

Set style by using associative array

Parameters

array

$values

Returns

self

setArrayStyle()

setArrayStyle(array  $style = array()) : self

Set style using associative array

Parameters

array

$style

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\AbstractStyle

Tags

codeCoverageIgnore

getStyleValues()

getStyleValues() : array

Get style values

An experiment to retrieve all style values in one function. This will reduce function call and increase cohesion between functions. Should be implemented in all styles.

Returns

array

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

ignoreScrutinizerPatch

getAlignment()

getAlignment() : string

Returns

string

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

since	0.13.0

setAlignment()

setAlignment(string  $value) : self

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

since	0.13.0

getAlign()

getAlign() : string

Returns

string

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

setAlign()

setAlign(string  $value = null) : self

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

getBasedOn()

getBasedOn() : string

Get parent style ID

Returns

string

setBasedOn()

setBasedOn(string  $value = 'Normal') : self

Set parent style ID

Parameters

string

$value

Returns

self

getNext()

getNext() : string

Get style for next paragraph

Returns

string

setNext()

setNext(string  $value = null) : self

Set style for next paragraph

Parameters

string

$value

Returns

self

getIndentation()

getIndentation() : \PhpOffice\PhpWord\Style\Indentation

Get shading

Returns

\PhpOffice\PhpWord\Style\Indentation

setIndentation()

setIndentation(mixed  $value = null) : self

Set shading

Parameters

mixed

$value

Returns

self

getIndent()

getIndent() : integer

Get indentation

Returns

integer

setIndent()

setIndent(integer  $value = null) : self

Set indentation

Parameters

integer

$value

Returns

self

getHanging()

getHanging() : integer

Get hanging

Returns

integer

setHanging()

setHanging(integer  $value = null) : self

Set hanging

Parameters

integer

$value

Returns

self

getSpace()

getSpace() : \PhpOffice\PhpWord\Style\Spacing

Get spacing

Returns

\PhpOffice\PhpWord\Style\Spacing

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

todo	Rename to getSpacing in 1.0

setSpace()

setSpace(mixed  $value = null) : self

Set spacing

Parameters

mixed

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

todo	Rename to setSpacing in 1.0

getSpaceBefore()

getSpaceBefore() : integer

Get space before paragraph

Returns

integer

setSpaceBefore()

setSpaceBefore(integer  $value = null) : self

Set space before paragraph

Parameters

integer

$value

Returns

self

getSpaceAfter()

getSpaceAfter() : integer

Get space after paragraph

Returns

integer

setSpaceAfter()

setSpaceAfter(integer  $value = null) : self

Set space after paragraph

Parameters

integer

$value

Returns

self

getSpacing()

getSpacing() : integer

Get spacing between lines

Returns

integer

setSpacing()

setSpacing(integer  $value = null) : self

Set spacing between lines

Parameters

integer

$value

Returns

self

getSpacingLineRule()

getSpacingLineRule() : string

Get spacing line rule

Returns

string

setSpacingLineRule()

setSpacingLineRule(string  $value) : \PhpOffice\PhpWord\Style\Paragraph

Set the spacing line rule

Parameters

string

$value

Possible values are defined in LineSpacingRule

Returns

\PhpOffice\PhpWord\Style\Paragraph

getLineHeight()

getLineHeight() : integer|float

Get line height

Returns

integer|float

setLineHeight()

setLineHeight(integer|float|string  $lineHeight) : self

Set the line height

Parameters

integer|float|string

$lineHeight

Throws

\PhpOffice\PhpWord\Exception\InvalidStyleException

Returns

self

hasWidowControl()

hasWidowControl() : boolean

Get allow first/last line to display on a separate page setting

Returns

boolean

setWidowControl()

setWidowControl(boolean  $value = true) : self

Set keep paragraph with next paragraph setting

Parameters

boolean

$value

Returns

self

isKeepNext()

isKeepNext() : boolean

Get keep paragraph with next paragraph setting

Returns

boolean

setKeepNext()

setKeepNext(boolean  $value = true) : self

Set keep paragraph with next paragraph setting

Parameters

boolean

$value

Returns

self

isKeepLines()

isKeepLines() : boolean

Get keep all lines on one page setting

Returns

boolean

setKeepLines()

setKeepLines(boolean  $value = true) : self

Set keep all lines on one page setting

Parameters

boolean

$value

Returns

self

hasPageBreakBefore()

hasPageBreakBefore() : boolean

Get start paragraph on next page setting

Returns

boolean

setPageBreakBefore()

setPageBreakBefore(boolean  $value = true) : self

Set start paragraph on next page setting

Parameters

boolean

$value

Returns

self

getNumStyle()

getNumStyle() : string

Get numbering style name

Returns

string

setNumStyle()

setNumStyle(string  $value) : self

Set numbering style name

Parameters

string

$value

Returns

self

getNumLevel()

getNumLevel() : integer

Get numbering level

Returns

integer

setNumLevel()

setNumLevel(integer  $value) : self

Set numbering level

Parameters

integer

$value

Returns

self

getTabs()

getTabs() : array<mixed,\PhpOffice\PhpWord\Style\Tab>

Get tabs

Returns

array<mixed,\PhpOffice\PhpWord\Style\Tab>

setTabs()

setTabs(array  $value = null) : self

Set tabs

Parameters

array

$value

Returns

self

getWidowControl()

getWidowControl()

Get allow first/last line to display on a separate page setting

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

getKeepNext()

getKeepNext()

Get keep paragraph with next paragraph setting

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

getKeepLines()

getKeepLines()

Get keep all lines on one page setting

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

getPageBreakBefore()

getPageBreakBefore()

Get start paragraph on next page setting

Inherited from: \PhpOffice\PhpWord\Style\Paragraph

Tags

codeCoverageIgnore

getShading()

getShading() : \PhpOffice\PhpWord\Style\Shading

Get shading

Returns

\PhpOffice\PhpWord\Style\Shading

setShading()

setShading(mixed  $value = null) : self

Set shading

Parameters

mixed

$value

Returns

self

hasContextualSpacing()

hasContextualSpacing() : boolean

Get contextualSpacing

Returns

boolean

setContextualSpacing()

setContextualSpacing(boolean  $contextualSpacing) : self

Set contextualSpacing

Parameters

boolean

$contextualSpacing

Returns

self

isBidi()

isBidi() : boolean

Get bidirectional

Returns

boolean

setBidi()

setBidi(boolean  $bidi) : self

Set bidi

Parameters

boolean

$bidi

Set to true to write from right to left

Returns

self

getTextAlignment()

getTextAlignment() : string

Get textAlignment

Returns

string

setTextAlignment()

setTextAlignment(string  $textAlignment) : self

Set textAlignment

Parameters

string

$textAlignment

Returns

self

hasSuppressAutoHyphens()

hasSuppressAutoHyphens() : boolean

Returns

boolean

setSuppressAutoHyphens()

setSuppressAutoHyphens(boolean  $suppressAutoHyphens)

Parameters

boolean

$suppressAutoHyphens

setNonEmptyVal()

setNonEmptyVal(string  $value, string  $default) : string

Set default for null and empty value

Parameters

string	$value	(was: mixed)
string	$default	(was: mixed)

Returns

string —

(was: mixed)

setBoolVal()

setBoolVal(boolean  $value, boolean  $default) : boolean

Set bool value

Parameters

boolean	$value
boolean	$default

Returns

boolean

setNumericVal()

setNumericVal(mixed  $value, integer|float|null  $default = null) : integer|float|null

Set numeric value

Parameters

mixed	$value
integer\|float\|null	$default

Returns

integer|float|null

setIntVal()

setIntVal(integer|null  $value, integer|null  $default = null) : integer|null

Set integer value: Convert string that contains only numeric into integer

Parameters

integer\|null	$value
integer\|null	$default

Returns

integer|null

setFloatVal()

setFloatVal(mixed  $value, float|null  $default = null) : float|null

Set float value: Convert string that contains only numeric into float

Parameters

mixed	$value
float\|null	$default

Returns

float|null

setEnumVal()

setEnumVal(mixed  $value = null, array  $enum = array(), mixed  $default = null) : mixed

Set enum value

Parameters

mixed	$value
array	$enum
mixed	$default

Throws

\InvalidArgumentException

Returns

mixed

setObjectVal()

setObjectVal(mixed  $value, string  $styleName,   $style) : mixed

Set object value

Parameters

mixed	$value
string	$styleName
	$style

Returns

mixed

setPairedVal()

setPairedVal(  $property,   $pairProperty, boolean  $value) : self

Set $property value and set $pairProperty = false when $value = true

Parameters

	$property
	$pairProperty
boolean	$value

Returns

self