\PhpOffice\PhpWord\StyleTextBox

TextBox style

Width, height, left/hpos, top/vpos, hrel, vrel, wrap, zindex

Summary

Methods

Properties

Constants

__construct()
getMarginTop()
setMarginTop()
getMarginLeft()
setMarginLeft()
getWrappingStyle()
setWrappingStyle()
getPositioning()
setPositioning()
getPosHorizontal()
setPosHorizontal()
getPosVertical()
setPosVertical()
getPosHorizontalRel()
setPosHorizontalRel()
getPosVerticalRel()
setPosVerticalRel()
getAlignment()
setAlignment()
getAlign()
setAlign()
getUnit()
setUnit()
getWidth()
setWidth()
getHeight()
setHeight()
getLeft()
setLeft()
getTop()
setTop()
getPos()
setPos()
getHPos()
setHPos()
getVPos()
setVPos()
getHPosRelTo()
setHPosRelTo()
getVPosRelTo()
setVPosRelTo()
getWrap()
setWrap()
getWrapDistanceTop()
setWrapDistanceTop()
getWrapDistanceBottom()
setWrapDistanceBottom()
getWrapDistanceLeft()
setWrapDistanceLeft()
getWrapDistanceRight()
setWrapDistanceRight()
getPosition()
setPosition()
getStyleName()
setStyleName()
getIndex()
setIndex()
isAuto()
setAuto()
getChildStyleValue()
setStyleValue()
setStyleByArray()
setArrayStyle()
setInnerMarginTop()
getInnerMarginTop()
setInnerMarginLeft()
getInnerMarginLeft()
setInnerMarginRight()
getInnerMarginRight()
setInnerMarginBottom()
getInnerMarginBottom()
setInnerMargin()
getInnerMargin()
hasInnerMargins()
setBorderSize()
getBorderSize()
setBorderColor()
getBorderColor()

No public properties found

WRAPPING_STYLE_INLINE
WRAPPING_STYLE_SQUARE
WRAPPING_STYLE_TIGHT
WRAPPING_STYLE_BEHIND
WRAPPING_STYLE_INFRONT
POSITION_HORIZONTAL_LEFT
POSITION_HORIZONTAL_CENTER
POSITION_HORIZONTAL_RIGHT
POSITION_VERTICAL_TOP
POSITION_VERTICAL_CENTER
POSITION_VERTICAL_BOTTOM
POSITION_VERTICAL_INSIDE
POSITION_VERTICAL_OUTSIDE
POSITION_RELATIVE_TO_MARGIN
POSITION_RELATIVE_TO_PAGE
POSITION_RELATIVE_TO_COLUMN
POSITION_RELATIVE_TO_CHAR
POSITION_RELATIVE_TO_TEXT
POSITION_RELATIVE_TO_LINE
POSITION_RELATIVE_TO_LMARGIN
POSITION_RELATIVE_TO_RMARGIN
POSITION_RELATIVE_TO_TMARGIN
POSITION_RELATIVE_TO_BMARGIN
POSITION_RELATIVE_TO_IMARGIN
POSITION_RELATIVE_TO_OMARGIN
POSITION_ABSOLUTE
POSITION_RELATIVE
UNIT_PT
UNIT_PX
POS_ABSOLUTE
POS_RELATIVE
POS_CENTER
POS_LEFT
POS_RIGHT
POS_TOP
POS_BOTTOM
POS_INSIDE
POS_OUTSIDE
POS_RELTO_MARGIN
POS_RELTO_PAGE
POS_RELTO_COLUMN
POS_RELTO_CHAR
POS_RELTO_TEXT
POS_RELTO_LINE
POS_RELTO_LMARGIN
POS_RELTO_RMARGIN
POS_RELTO_TMARGIN
POS_RELTO_BMARGIN
POS_RELTO_IMARGIN
POS_RELTO_OMARGIN
WRAP_INLINE
WRAP_SQUARE
WRAP_TIGHT
WRAP_THROUGH
WRAP_TOPBOTTOM
WRAP_BEHIND
WRAP_INFRONT

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

$styleName
$index
$aliases

N/A

No private methods found

$alignment
$unit
$width
$height
$left
$top
$pos
$hPos
$hPosRelTo
$vPos
$vPosRelTo
$wrap
$wrapDistanceTop
$wrapDistanceBottom
$wrapDistanceLeft
$wrapDistanceRight
$position
$isAuto
$innerMarginTop
$innerMarginLeft
$innerMarginRight
$innerMarginBottom
$borderSize
$borderColor

N/A

File: vendor/phpoffice/phpword/src/PhpWord/Style/TextBox.php
Package: Default
Class hierarchy: \PhpOffice\PhpWord\Style\AbstractStyle

\PhpOffice\PhpWord\Style\Frame

\PhpOffice\PhpWord\Style\Image

\PhpOffice\PhpWord\Style\TextBox

Tags

since	0.11.0

Constants

WRAPPING_STYLE_INLINE

WRAPPING_STYLE_INLINE = self::WRAP_INLINE

Backward compatibility constants

Inherited from: \PhpOffice\PhpWord\Style\Image

Tags

const	string

WRAPPING_STYLE_SQUARE

WRAPPING_STYLE_SQUARE = self::WRAP_SQUARE

WRAPPING_STYLE_TIGHT

WRAPPING_STYLE_TIGHT = self::WRAP_TIGHT

WRAPPING_STYLE_BEHIND

WRAPPING_STYLE_BEHIND = self::WRAP_BEHIND

WRAPPING_STYLE_INFRONT

WRAPPING_STYLE_INFRONT = self::WRAP_INFRONT

POSITION_HORIZONTAL_LEFT

POSITION_HORIZONTAL_LEFT = self::POS_LEFT

POSITION_HORIZONTAL_CENTER

POSITION_HORIZONTAL_CENTER = self::POS_CENTER

POSITION_HORIZONTAL_RIGHT

POSITION_HORIZONTAL_RIGHT = self::POS_RIGHT

POSITION_VERTICAL_TOP

POSITION_VERTICAL_TOP = self::POS_TOP

POSITION_VERTICAL_CENTER

POSITION_VERTICAL_CENTER = self::POS_CENTER

POSITION_VERTICAL_BOTTOM

POSITION_VERTICAL_BOTTOM = self::POS_BOTTOM

POSITION_VERTICAL_INSIDE

POSITION_VERTICAL_INSIDE = self::POS_INSIDE

POSITION_VERTICAL_OUTSIDE

POSITION_VERTICAL_OUTSIDE = self::POS_OUTSIDE

POSITION_RELATIVE_TO_MARGIN

POSITION_RELATIVE_TO_MARGIN = self::POS_RELTO_MARGIN

POSITION_RELATIVE_TO_PAGE

POSITION_RELATIVE_TO_PAGE = self::POS_RELTO_PAGE

POSITION_RELATIVE_TO_COLUMN

POSITION_RELATIVE_TO_COLUMN = self::POS_RELTO_COLUMN

POSITION_RELATIVE_TO_CHAR

POSITION_RELATIVE_TO_CHAR = self::POS_RELTO_CHAR

POSITION_RELATIVE_TO_TEXT

POSITION_RELATIVE_TO_TEXT = self::POS_RELTO_TEXT

POSITION_RELATIVE_TO_LINE

POSITION_RELATIVE_TO_LINE = self::POS_RELTO_LINE

POSITION_RELATIVE_TO_LMARGIN

POSITION_RELATIVE_TO_LMARGIN = self::POS_RELTO_LMARGIN

POSITION_RELATIVE_TO_RMARGIN

POSITION_RELATIVE_TO_RMARGIN = self::POS_RELTO_RMARGIN

POSITION_RELATIVE_TO_TMARGIN

POSITION_RELATIVE_TO_TMARGIN = self::POS_RELTO_TMARGIN

POSITION_RELATIVE_TO_BMARGIN

POSITION_RELATIVE_TO_BMARGIN = self::POS_RELTO_BMARGIN

POSITION_RELATIVE_TO_IMARGIN

POSITION_RELATIVE_TO_IMARGIN = self::POS_RELTO_IMARGIN

POSITION_RELATIVE_TO_OMARGIN

POSITION_RELATIVE_TO_OMARGIN = self::POS_RELTO_OMARGIN

POSITION_ABSOLUTE

POSITION_ABSOLUTE = self::POS_ABSOLUTE

POSITION_RELATIVE

POSITION_RELATIVE = self::POS_RELATIVE

UNIT_PT

UNIT_PT = 'pt'

Length unit

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

const	string

UNIT_PX

UNIT_PX = 'px'

POS_ABSOLUTE

POS_ABSOLUTE = 'absolute'

General positioning options.

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

const	string

POS_RELATIVE

POS_RELATIVE = 'relative'

POS_CENTER

POS_CENTER = 'center'

Horizontal/vertical value

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

const	string

POS_LEFT

POS_LEFT = 'left'

POS_RIGHT

POS_RIGHT = 'right'

POS_TOP

POS_TOP = 'top'

POS_BOTTOM

POS_BOTTOM = 'bottom'

POS_INSIDE

POS_INSIDE = 'inside'

POS_OUTSIDE

POS_OUTSIDE = 'outside'

POS_RELTO_MARGIN

POS_RELTO_MARGIN = 'margin'

Position relative to

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

const	string

POS_RELTO_PAGE

POS_RELTO_PAGE = 'page'

POS_RELTO_COLUMN

POS_RELTO_COLUMN = 'column'

POS_RELTO_CHAR

POS_RELTO_CHAR = 'char'

POS_RELTO_TEXT

POS_RELTO_TEXT = 'text'

POS_RELTO_LINE

POS_RELTO_LINE = 'line'

POS_RELTO_LMARGIN

POS_RELTO_LMARGIN = 'left-margin-area'

POS_RELTO_RMARGIN

POS_RELTO_RMARGIN = 'right-margin-area'

POS_RELTO_TMARGIN

POS_RELTO_TMARGIN = 'top-margin-area'

POS_RELTO_BMARGIN

POS_RELTO_BMARGIN = 'bottom-margin-area'

POS_RELTO_IMARGIN

POS_RELTO_IMARGIN = 'inner-margin-area'

POS_RELTO_OMARGIN

POS_RELTO_OMARGIN = 'outer-margin-area'

WRAP_INLINE

WRAP_INLINE = 'inline'

Wrap type

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

const	string

WRAP_SQUARE

WRAP_SQUARE = 'square'

WRAP_TIGHT

WRAP_TIGHT = 'tight'

WRAP_THROUGH

WRAP_THROUGH = 'through'

WRAP_TOPBOTTOM

WRAP_TOPBOTTOM = 'topAndBottom'

WRAP_BEHIND

WRAP_BEHIND = 'behind'

WRAP_INFRONT

WRAP_INFRONT = 'infront'

Properties

$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

$alignment

$alignment : string

Type

string

$unit

$unit : string

Unit

Type

string

$width

$width : integer|float

Width

Type

integer|float

$height

$height : integer|float

Height

Type

integer|float

$left

$left : integer|float

Leftmost (horizontal) position

Type

integer|float

$top

$top : integer|float

Topmost (vertical) position

Type

integer|float

$pos

$pos : string

Position type: absolute|relative

Type

string

$hPos

$hPos : string

Horizontal position

Type

string

$hPosRelTo

$hPosRelTo : string

Horizontal position relative to

Type

string

$vPos

$vPos : string

Vertical position

Type

string

$vPosRelTo

$vPosRelTo : string

Vertical position relative to

Type

string

$wrap

$wrap : string

Wrap type

Type

string

$wrapDistanceTop

$wrapDistanceTop : float

Top wrap distance

Type

float

$wrapDistanceBottom

$wrapDistanceBottom : float

Bottom wrap distance

Type

float

$wrapDistanceLeft

$wrapDistanceLeft : float

Left wrap distance

Type

float

$wrapDistanceRight

$wrapDistanceRight : float

Right wrap distance

Type

float

$position

$position : integer

Vertically raised or lowered text

Type

integer

$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

$innerMarginTop

$innerMarginTop : integer

margin top

Type

integer

$innerMarginLeft

$innerMarginLeft : integer

margin left

Type

integer

$innerMarginRight

$innerMarginRight : integer

margin right

Type

integer

$innerMarginBottom

$innerMarginBottom : integer

Cell margin bottom

Type

integer

$borderSize

$borderSize : integer

border size

Type

integer

$borderColor

$borderColor : string

border color

Type

string

Methods

__construct()

__construct(array  $style = array())

Create a new instance

Parameters

array

$style

getMarginTop()

getMarginTop() : integer|float

Get margin top

Returns

integer|float

setMarginTop()

setMarginTop(integer|float  $value) : self

Set margin top

Parameters

integer|float

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Image

Tags

ignoreScrutinizerPatch

getMarginLeft()

getMarginLeft() : integer|float

Get margin left

Returns

integer|float

setMarginLeft()

setMarginLeft(integer|float  $value) : self

Set margin left

Parameters

integer|float

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Image

Tags

ignoreScrutinizerPatch

getWrappingStyle()

getWrappingStyle() : string

Get wrapping style

Returns

string

setWrappingStyle()

setWrappingStyle(string  $wrappingStyle) : self

Set wrapping style

Parameters

string

$wrappingStyle

Throws

\InvalidArgumentException

Returns

self

getPositioning()

getPositioning() : string

Get positioning type

Returns

string

setPositioning()

setPositioning(string  $positioning) : self

Set positioning type

Parameters

string

$positioning

Throws

\InvalidArgumentException

Returns

self

getPosHorizontal()

getPosHorizontal() : string

Get horizontal alignment

Returns

string

setPosHorizontal()

setPosHorizontal(string  $alignment) : self

Set horizontal alignment

Parameters

string

$alignment

Throws

\InvalidArgumentException

Returns

self

getPosVertical()

getPosVertical() : string

Get vertical alignment

Returns

string

setPosVertical()

setPosVertical(string  $alignment) : self

Set vertical alignment

Parameters

string

$alignment

Throws

\InvalidArgumentException

Returns

self

getPosHorizontalRel()

getPosHorizontalRel() : string

Get horizontal relation

Returns

string

setPosHorizontalRel()

setPosHorizontalRel(string  $relto) : self

Set horizontal relation

Parameters

string

$relto

Throws

\InvalidArgumentException

Returns

self

getPosVerticalRel()

getPosVerticalRel() : string

Get vertical relation

Returns

string

setPosVerticalRel()

setPosVerticalRel(string  $relto) : self

Set vertical relation

Parameters

string

$relto

Throws

\InvalidArgumentException

Returns

self

getAlignment()

getAlignment() : string

Returns

string

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

since	0.13.0

setAlignment()

setAlignment(string  $value) : self

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

since	0.13.0

getAlign()

getAlign() : string

Returns

string

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

codeCoverageIgnore

setAlign()

setAlign(string  $value = null) : self

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

codeCoverageIgnore

getUnit()

getUnit() : string

Get unit

Returns

string

setUnit()

setUnit(string  $value) : self

Set unit

Parameters

string

$value

Returns

self

getWidth()

getWidth() : integer|float

Get width

Returns

integer|float

setWidth()

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

Set width

Parameters

integer|float

$value

Returns

self

getHeight()

getHeight() : integer|float

Get height

Returns

integer|float

setHeight()

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

Set height

Parameters

integer|float

$value

Returns

self

getLeft()

getLeft() : integer|float

Get left

Returns

integer|float

setLeft()

setLeft(integer|float  $value) : self

Set left

Parameters

integer|float

$value

Returns

self

getTop()

getTop() : integer|float

Get topmost position

Returns

integer|float

setTop()

setTop(integer|float  $value) : self

Set topmost position

Parameters

integer|float

$value

Returns

self

getPos()

getPos() : string

Get position type

Returns

string

setPos()

setPos(string  $value) : self

Set position type

Parameters

string

$value

Returns

self

getHPos()

getHPos() : string

Get horizontal position

Returns

string

setHPos()

setHPos(string  $value) : self

Set horizontal position

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

since	0.12.0 "absolute" option is available.

getVPos()

getVPos() : string

Get vertical position

Returns

string

setVPos()

setVPos(string  $value) : self

Set vertical position

Parameters

string

$value

Returns

self

Inherited from: \PhpOffice\PhpWord\Style\Frame

Tags

since	0.12.0 "absolute" option is available.

getHPosRelTo()

getHPosRelTo() : string

Get horizontal position relative to

Returns

string

setHPosRelTo()

setHPosRelTo(string  $value) : self

Set horizontal position relative to

Parameters

string

$value

Returns

self

getVPosRelTo()

getVPosRelTo() : string

Get vertical position relative to

Returns

string

setVPosRelTo()

setVPosRelTo(string  $value) : self

Set vertical position relative to

Parameters

string

$value

Returns

self

getWrap()

getWrap() : string

Get wrap type

Returns

string

setWrap()

setWrap(string  $value) : self

Set wrap type

Parameters

string

$value

Returns

self

getWrapDistanceTop()

getWrapDistanceTop() : float

Get top distance from text wrap

Returns

float

setWrapDistanceTop()

setWrapDistanceTop(integer  $value = null) : self

Set top distance from text wrap

Parameters

integer

$value

Returns

self

getWrapDistanceBottom()

getWrapDistanceBottom() : float

Get bottom distance from text wrap

Returns

float

setWrapDistanceBottom()

setWrapDistanceBottom(float  $value = null) : self

Set bottom distance from text wrap

Parameters

float

$value

Returns

self

getWrapDistanceLeft()

getWrapDistanceLeft() : float

Get left distance from text wrap

Returns

float

setWrapDistanceLeft()

setWrapDistanceLeft(float  $value = null) : self

Set left distance from text wrap

Parameters

float

$value

Returns

self

getWrapDistanceRight()

getWrapDistanceRight() : float

Get right distance from text wrap

Returns

float

setWrapDistanceRight()

setWrapDistanceRight(float  $value = null) : self

Set right distance from text wrap

Parameters

float

$value

Returns

self

getPosition()

getPosition() : integer

Get position

Returns

integer

setPosition()

setPosition(integer  $value = null) : self

Set position

Parameters

integer

$value

Returns

self

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

setInnerMarginTop()

setInnerMarginTop(integer  $value = null)

Set margin top.

Parameters

integer

$value

getInnerMarginTop()

getInnerMarginTop() : integer

Get margin top

Returns

integer

setInnerMarginLeft()

setInnerMarginLeft(integer  $value = null)

Set margin left.

Parameters

integer

$value

getInnerMarginLeft()

getInnerMarginLeft() : integer

Get margin left

Returns

integer

setInnerMarginRight()

setInnerMarginRight(integer  $value = null)

Set margin right.

Parameters

integer

$value

getInnerMarginRight()

getInnerMarginRight() : integer

Get margin right

Returns

integer

setInnerMarginBottom()

setInnerMarginBottom(integer  $value = null)

Set margin bottom.

Parameters

integer

$value

getInnerMarginBottom()

getInnerMarginBottom() : integer

Get margin bottom

Returns

integer

setInnerMargin()

setInnerMargin(integer  $value = null)

Set TLRB cell margin.

Parameters

integer

$value

Margin in twips

getInnerMargin()

getInnerMargin() : array<mixed,integer>

Get cell margin

Returns

array<mixed,integer>

hasInnerMargins()

hasInnerMargins() : boolean

Has inner margin?

Returns

boolean

setBorderSize()

setBorderSize(integer  $value = null)

Set border size.

Parameters

integer

$value

Size in points

getBorderSize()

getBorderSize() : integer

Get border size

Returns

integer

setBorderColor()

setBorderColor(string  $value = null)

Set border color.

Parameters

string

$value

getBorderColor()

getBorderColor() : string

Get border color

Returns

string

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