\PhpOffice\PhpWord\StyleFrame

getStyleName()

getStyleName() : string

Get style name

Returns

setStyleName()

setStyleName(string  $value) : self

Set style name

Parameters

Returns

getIndex()

getIndex() : integer|null

Get index number

Returns

setIndex()

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

Set index number

Parameters

Returns

isAuto()

isAuto() : boolean

Get is automatic style flag

Returns

setAuto()

setAuto(boolean  $value = true) : self

Set is automatic style flag

Parameters

Returns

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

Returns

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

Returns

setStyleByArray()

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

Set style by using associative array

Parameters

Returns

setArrayStyle()

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

Set style using associative array

Parameters

Returns

__construct()

__construct(array  $style = array()) 

Create a new instance

Parameters

getAlignment()

getAlignment() : string

Returns

setAlignment()

setAlignment(string  $value) : self

Parameters

Returns

getAlign()

getAlign() : string

Returns

setAlign()

setAlign(string  $value = null) : self

Parameters

Returns

getUnit()

getUnit() : string

Get unit

Returns

setUnit()

setUnit(string  $value) : self

Set unit

Parameters

Returns

getWidth()

getWidth() : integer|float

Get width

Returns

setWidth()

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

Set width

Parameters

Returns

getHeight()

getHeight() : integer|float

Get height

Returns

setHeight()

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

Set height

Parameters

Returns

getLeft()

getLeft() : integer|float

Get left

Returns

setLeft()

setLeft(integer|float  $value) : self

Set left

Parameters

Returns

getTop()

getTop() : integer|float

Get topmost position

Returns

setTop()

setTop(integer|float  $value) : self

Set topmost position

Parameters

Returns

getPos()

getPos() : string

Get position type

Returns

setPos()

setPos(string  $value) : self

Set position type

Parameters

Returns

getHPos()

getHPos() : string

Get horizontal position

Returns

setHPos()

setHPos(string  $value) : self

Set horizontal position

Parameters

Returns

getVPos()

getVPos() : string

Get vertical position

Returns

setVPos()

setVPos(string  $value) : self

Set vertical position

Parameters

Returns

getHPosRelTo()

getHPosRelTo() : string

Get horizontal position relative to

Returns

setHPosRelTo()

setHPosRelTo(string  $value) : self

Set horizontal position relative to

Parameters

Returns

getVPosRelTo()

getVPosRelTo() : string

Get vertical position relative to

Returns

setVPosRelTo()

setVPosRelTo(string  $value) : self

Set vertical position relative to

Parameters

Returns

getWrap()

getWrap() : string

Get wrap type

Returns

setWrap()

setWrap(string  $value) : self

Set wrap type

Parameters

Returns

getWrapDistanceTop()

getWrapDistanceTop() : float

Get top distance from text wrap

Returns

setWrapDistanceTop()

setWrapDistanceTop(integer  $value = null) : self

Set top distance from text wrap

Parameters

Returns

getWrapDistanceBottom()

getWrapDistanceBottom() : float

Get bottom distance from text wrap

Returns

setWrapDistanceBottom()

setWrapDistanceBottom(float  $value = null) : self

Set bottom distance from text wrap

Parameters

Returns

getWrapDistanceLeft()

getWrapDistanceLeft() : float

Get left distance from text wrap

Returns

setWrapDistanceLeft()

setWrapDistanceLeft(float  $value = null) : self

Set left distance from text wrap

Parameters

Returns

getWrapDistanceRight()

getWrapDistanceRight() : float

Get right distance from text wrap

Returns

setWrapDistanceRight()

setWrapDistanceRight(float  $value = null) : self

Set right distance from text wrap

Parameters

Returns

getPosition()

getPosition() : integer

Get position

Returns

setPosition()

setPosition(integer  $value = null) : self

Set position

Parameters

Returns

setNonEmptyVal()

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

Set default for null and empty value

Parameters

Returns

(was: mixed)

setBoolVal()

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

Set bool value

Parameters

Returns

setNumericVal()

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

Set numeric value

Parameters

Returns

setIntVal()

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

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

Parameters

Returns

setFloatVal()

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

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

Parameters

Returns

setEnumVal()

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

Set enum value

Parameters

Throws

\InvalidArgumentException

Returns

setObjectVal()

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

Set object value

Parameters

Returns

setPairedVal()

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

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

Parameters

Returns