\PhpOffice\PhpWord\StyleSection

Section settings

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()
__construct()
getPaperSize()
setPaperSize()
setSettingValue()
setOrientation()
getOrientation()
setPortrait()
setLandscape()
getPageSizeW()
setPageSizeW()
getPageSizeH()
setPageSizeH()
getMarginTop()
setMarginTop()
getMarginLeft()
setMarginLeft()
getMarginRight()
setMarginRight()
getMarginBottom()
setMarginBottom()
getGutter()
setGutter()
getHeaderHeight()
setHeaderHeight()
getFooterHeight()
setFooterHeight()
getPageNumberingStart()
setPageNumberingStart()
getColsNum()
setColsNum()
getColsSpace()
setColsSpace()
getBreakType()
setBreakType()
getLineNumbering()
setLineNumbering()

No public properties found

ORIENTATION_PORTRAIT
ORIENTATION_LANDSCAPE
DEFAULT_WIDTH
DEFAULT_HEIGHT
DEFAULT_MARGIN
DEFAULT_GUTTER
DEFAULT_HEADER_HEIGHT
DEFAULT_FOOTER_HEIGHT
DEFAULT_COLUMN_COUNT
DEFAULT_COLUMN_SPACING

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
$orientation
$paper
$pageSizeW
$pageSizeH
$marginTop
$marginLeft
$marginRight
$marginBottom
$gutter
$headerHeight
$footerHeight
$pageNumberingStart
$colsNum
$colsSpace
$breakType
$lineNumbering

N/A

Constants

ORIENTATION_PORTRAIT

ORIENTATION_PORTRAIT = 'portrait'

Page orientation

Tags

const	string

ORIENTATION_LANDSCAPE

ORIENTATION_LANDSCAPE = 'landscape'

DEFAULT_WIDTH

DEFAULT_WIDTH = 11905.511811024

Page default constants

Tags

const	int\|float

DEFAULT_HEIGHT

DEFAULT_HEIGHT = 16837.79527559

DEFAULT_MARGIN

DEFAULT_MARGIN = 1440

DEFAULT_GUTTER

DEFAULT_GUTTER = 0

DEFAULT_HEADER_HEIGHT

DEFAULT_HEADER_HEIGHT = 720

DEFAULT_FOOTER_HEIGHT

DEFAULT_FOOTER_HEIGHT = 720

DEFAULT_COLUMN_COUNT

DEFAULT_COLUMN_COUNT = 1

DEFAULT_COLUMN_SPACING

DEFAULT_COLUMN_SPACING = 720

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

$orientation

$orientation : string

Page Orientation

Type

string

$paper

$paper : \PhpOffice\PhpWord\Style\Paper

Paper size

Type

\PhpOffice\PhpWord\Style\Paper

$pageSizeW

$pageSizeW : integer|float

Page Size Width

Type

integer|float

$pageSizeH

$pageSizeH : integer|float

Page Size Height

Type

integer|float

$marginTop

$marginTop : integer|float

Top margin spacing

Type

integer|float

$marginLeft

$marginLeft : integer|float

Left margin spacing

Type

integer|float

$marginRight

$marginRight : integer|float

Right margin spacing

Type

integer|float

$marginBottom

$marginBottom : integer|float

Bottom margin spacing

Type

integer|float

$gutter

$gutter : integer|float

Page gutter spacing

Type

integer|float

$headerHeight

$headerHeight : integer|float

Header height

Type

integer|float

$footerHeight

$footerHeight : integer|float

Footer height

Type

integer|float

$pageNumberingStart

$pageNumberingStart : integer

Page Numbering Start

Type

integer

$colsNum

$colsNum : integer

Section columns count

Type

integer

$colsSpace

$colsSpace : integer|float

Section spacing between columns

Type

integer|float

$breakType

$breakType : string

Section break type

Options:

nextPage: Next page section break
nextColumn: Column section break
continuous: Continuous section break
evenPage: Even page section break
oddPage: Odd page section break

Type

string

$lineNumbering

$lineNumbering : \PhpOffice\PhpWord\Style\LineNumbering

Line numbering

Type

\PhpOffice\PhpWord\Style\LineNumbering

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, string  $value) : self

Set style value template method

Some child classes have their own specific overrides. Backward compability check for versions < 0.10.0 which use underscore prefix for their private properties. Check if the set method is exists. Throws an exception?

Parameters

string	$key
string	$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

__construct()

__construct()

Create new instance

getPaperSize()

getPaperSize() : string

Get paper size

Returns

string

setPaperSize()

setPaperSize(string  $value = 'A4') : self

Set paper size

Parameters

string

$value

Returns

self

setSettingValue()

setSettingValue(string  $key, string  $value) : self

Set Setting Value

Parameters

string	$key
string	$value

Returns

self

setOrientation()

setOrientation(string  $value = null) : self

Set orientation

Parameters

string

$value

Returns

self

getOrientation()

getOrientation() : string

Get Page Orientation

Returns

string

setPortrait()

setPortrait() : self

Set Portrait Orientation

Returns

self

setLandscape()

setLandscape() : self

Set Landscape Orientation

Returns

self

getPageSizeW()

getPageSizeW() : integer|float|null

Get Page Size Width

Returns

integer|float|null

Inherited from: \PhpOffice\PhpWord\Style\Section

Tags

since	0.12.0

setPageSizeW()

setPageSizeW(integer|float|null  $value = null) : \PhpOffice\PhpWord\Style\Section

Parameters

integer|float|null

$value

Returns

\PhpOffice\PhpWord\Style\Section

Inherited from: \PhpOffice\PhpWord\Style\Section

Tags

since	0.12.0

getPageSizeH()

getPageSizeH() : integer|float|null

Get Page Size Height

Returns

integer|float|null

Inherited from: \PhpOffice\PhpWord\Style\Section

Tags

since	0.12.0

setPageSizeH()

setPageSizeH(integer|float|null  $value = null) : \PhpOffice\PhpWord\Style\Section

Parameters

integer|float|null

$value

Returns

\PhpOffice\PhpWord\Style\Section

Inherited from: \PhpOffice\PhpWord\Style\Section

Tags

since	0.12.0

getMarginTop()

getMarginTop() : integer|float

Get Margin Top

Returns

integer|float

setMarginTop()

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

Set Margin Top

Parameters

integer|float

$value

Returns

self

getMarginLeft()

getMarginLeft() : integer|float

Get Margin Left

Returns

integer|float

setMarginLeft()

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

Set Margin Left

Parameters

integer|float

$value

Returns

self

getMarginRight()

getMarginRight() : integer|float

Get Margin Right

Returns

integer|float

setMarginRight()

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

Set Margin Right

Parameters

integer|float

$value

Returns

self

getMarginBottom()

getMarginBottom() : integer|float

Get Margin Bottom

Returns

integer|float

setMarginBottom()

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

Set Margin Bottom

Parameters

integer|float

$value

Returns

self

getGutter()

getGutter() : integer|float

Get gutter

Returns

integer|float

setGutter()

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

Set gutter

Parameters

integer|float

$value

Returns

self

getHeaderHeight()

getHeaderHeight() : integer|float

Get Header Height

Returns

integer|float

setHeaderHeight()

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

Set Header Height

Parameters

integer|float

$value

Returns

self

getFooterHeight()

getFooterHeight() : integer|float

Get Footer Height

Returns

integer|float

setFooterHeight()

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

Set Footer Height

Parameters

integer|float

$value

Returns

self

getPageNumberingStart()

getPageNumberingStart() : null|integer

Get page numbering start

Returns

null|integer

setPageNumberingStart()

setPageNumberingStart(null|integer  $pageNumberingStart = null) : self

Set page numbering start

Parameters

null|integer

$pageNumberingStart

Returns

self

getColsNum()

getColsNum() : integer

Get Section Columns Count

Returns

integer

setColsNum()

setColsNum(integer  $value = null) : self

Set Section Columns Count

Parameters

integer

$value

Returns

self

getColsSpace()

getColsSpace() : integer|float

Get Section Space Between Columns

Returns

integer|float

setColsSpace()

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

Set Section Space Between Columns

Parameters

integer|float

$value

Returns

self

getBreakType()

getBreakType() : string

Get Break Type

Returns

string

setBreakType()

setBreakType(string  $value = null) : self

Set Break Type

Parameters

string

$value

Returns

self

getLineNumbering()

getLineNumbering() : \PhpOffice\PhpWord\Style\LineNumbering

Get line numbering

Returns

\PhpOffice\PhpWord\Style\LineNumbering

setLineNumbering()

setLineNumbering(mixed  $value = null) : self

Set line numbering

Parameters

mixed

$value

Returns

self

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