\PhpOffice\PhpWord\ElementTextBox

__call()

__call(mixed  $function, mixed  $args) : \PhpOffice\PhpWord\Element\AbstractElement

Magic method to catch all 'addElement' variation

This removes addText, addTextRun, etc. When adding new element, we have to add the model in the class docblock with @method.

Warning: This makes capitalization matters, e.g. addCheckbox or addcheckbox won't work.

Parameters

Returns

getElements()

getElements() : array<mixed,\PhpOffice\PhpWord\Element\AbstractElement>

Get all elements

Returns

getElement()

getElement(integer  $index) : \PhpOffice\PhpWord\Element\AbstractElement|null

Returns the element at the requested position

Parameters

Returns

removeElement()

removeElement(integer|\PhpOffice\PhpWord\Element\AbstractElement  $toRemove) 

Removes the element at requested index

Parameters

countElements()

countElements() : integer

Count elements

Returns

createTextRun()

createTextRun(mixed  $paragraphStyle = null) : \PhpOffice\PhpWord\Element\TextRun

Create textrun element

Parameters

Returns

createFootnote()

createFootnote(mixed  $paragraphStyle = null) : \PhpOffice\PhpWord\Element\Footnote

Create footnote element

Parameters

Returns

getPhpWord()

getPhpWord() : \PhpOffice\PhpWord\PhpWord

Get PhpWord

Returns

setPhpWord()

setPhpWord(\PhpOffice\PhpWord\PhpWord  $phpWord = null) 

Set PhpWord as reference.

Parameters

getSectionId()

getSectionId() : integer

Get section number

Returns

setDocPart()

setDocPart(string  $docPart, integer  $docPartId = 1) 

Set doc part.

Parameters

getDocPart()

getDocPart() : string

Get doc part

Returns

getDocPartId()

getDocPartId() : integer

Get doc part Id

Returns

getElementIndex()

getElementIndex() : integer

Get element index

Returns

setElementIndex()

setElementIndex(integer  $value) 

Set element index.

Parameters

getElementId()

getElementId() : string

Get element unique ID

Returns

setElementId()

setElementId() 

Set element unique ID from 6 first digit of md5.

getRelationId()

getRelationId() : integer

Get relation Id

Returns

setRelationId()

setRelationId(integer  $value) 

Set relation Id.

Parameters

getNestedLevel()

getNestedLevel() : integer

Get nested level

Returns

getCommentRangeStart()

getCommentRangeStart() : \PhpOffice\PhpWord\Element\Comment

Get comment start

Returns

setCommentRangeStart()

setCommentRangeStart(\PhpOffice\PhpWord\Element\Comment  $value) 

Set comment start

Parameters

getCommentRangeEnd()

getCommentRangeEnd() : \PhpOffice\PhpWord\Element\Comment

Get comment end

Returns

setCommentRangeEnd()

setCommentRangeEnd(\PhpOffice\PhpWord\Element\Comment  $value) 

Set comment end

Parameters

getParent()

getParent() 

setParentContainer()

setParentContainer(\PhpOffice\PhpWord\Element\AbstractElement  $container) 

Set parent container

Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell)

Parameters

isInSection()

isInSection() : boolean

Check if element is located in Section doc part (as opposed to Header/Footer)

Returns

setTrackChange()

setTrackChange(\PhpOffice\PhpWord\Element\TrackChange  $trackChange) 

Sets the trackChange information

Parameters

getTrackChange()

getTrackChange() : \PhpOffice\PhpWord\Element\TrackChange

Gets the trackChange information

Returns

setChangeInfo()

setChangeInfo(string  $type, string  $author, null|integer|\DateTime  $date = null) 

Set changed

Parameters

__construct()

__construct(mixed  $style = null) 

Create a new textbox

Parameters

getStyle()

getStyle() : \PhpOffice\PhpWord\Style\TextBox

Get textbox style

Returns

addText()

addText(string  $text, mixed  $fStyle = null, mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\Text

Parameters

Returns

addTextRun()

addTextRun(mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\TextRun

Parameters

Returns

addBookmark()

addBookmark(string  $name) : \PhpOffice\PhpWord\Element\Bookmark

Parameters

Returns

addLink()

addLink(string  $target, string  $text = null, mixed  $fStyle = null, mixed  $pStyle = null, boolean  $internal = false) : \PhpOffice\PhpWord\Element\Link

Parameters

Returns

addPreserveText()

addPreserveText(string  $text, mixed  $fStyle = null, mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\PreserveText

Parameters

Returns

addTextBreak()

addTextBreak(integer  $count = 1, mixed  $fStyle = null, mixed  $pStyle = null) : void

Parameters

addListItem()

addListItem(string  $txt, integer  $depth, mixed  $font = null, mixed  $list = null, mixed  $para = null) : \PhpOffice\PhpWord\Element\ListItem

Parameters

Returns

addListItemRun()

addListItemRun(integer  $depth, mixed  $listStyle = null, mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\ListItemRun

Parameters

Returns

addFootnote()

addFootnote(mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\Footnote

Parameters

Returns

addEndnote()

addEndnote(mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\Endnote

Parameters

Returns

addCheckBox()

addCheckBox(string  $name, mixed  $text, mixed  $fStyle = null, mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\CheckBox

Parameters

Returns

addTitle()

addTitle(string  $text, integer  $depth = 1) : \PhpOffice\PhpWord\Element\Title

Parameters

Returns

addTOC()

addTOC(mixed  $fontStyle = null, mixed  $tocStyle = null, integer  $minDepth = 1, integer  $maxDepth = 9) : \PhpOffice\PhpWord\Element\TOC

Parameters

Returns

addPageBreak()

addPageBreak() : \PhpOffice\PhpWord\Element\PageBreak

Returns

addTable()

addTable(mixed  $style = null) : \PhpOffice\PhpWord\Element\Table

Parameters

Returns

addImage()

addImage(string  $source, mixed  $style = null, boolean  $isWatermark = false, mixed  $name = null) : \PhpOffice\PhpWord\Element\Image

Parameters

Returns

addOLEObject()

addOLEObject(string  $source, mixed  $style = null) : \PhpOffice\PhpWord\Element\OLEObject

Parameters

Returns

addTextBox()

addTextBox(mixed  $style = null) : \PhpOffice\PhpWord\Element\TextBox

Parameters

Returns

addField()

addField(string  $type = null, array  $properties = array() : \PhpOffice\PhpWord\Element\Field

, array $options = array(), mixed $text = null)

Parameters

Returns

addLine()

addLine(mixed  $lineStyle = null) : \PhpOffice\PhpWord\Element\Line

Parameters

Returns

addShape()

addShape(string  $type, mixed  $style = null) : \PhpOffice\PhpWord\Element\Shape

Parameters

Returns

addChart()

addChart(string  $type, array  $categories, array  $values, array  $style = null) : \PhpOffice\PhpWord\Element\Chart

Parameters

Returns

addFormField()

addFormField(string  $type, mixed  $fStyle = null, mixed  $pStyle = null) : \PhpOffice\PhpWord\Element\FormField

Parameters

Returns

addSDT()

addSDT(string  $type) : \PhpOffice\PhpWord\Element\SDT

Parameters

Returns

addObject()

addObject(string  $source, mixed  $style = null) : \PhpOffice\PhpWord\Element\OLEObject

deprecated, use addOLEObject instead

Parameters

Returns

addElement()

addElement(string  $elementName) : \PhpOffice\PhpWord\Element\AbstractElement

Add element

Each element has different number of parameters passed

Parameters

Returns

setNewStyle()

setNewStyle(mixed  $styleObject, mixed  $styleValue = null, boolean  $returnObject = false) : mixed

Set new style value

Parameters

Returns

setEnumVal()

setEnumVal(string|null  $value = null, array<mixed,string>  $enum = array(), string|null  $default = null) : string|null

Set enum value

Parameters

Throws

\InvalidArgumentException

Returns

checkValidity()

checkValidity(string  $method) : boolean

Check if a method is allowed for the current container

Parameters

Throws

\BadMethodCallException

Returns

getMediaPart()

getMediaPart() : string

Return media element (image, object, link) container name

Returns

section|headerx|footerx|footnote|endnote

setMediaRelation()

setMediaRelation() 

Set relation Id for media elements (link, image, object; legacy of OOXML)

• Image element needs to be passed to Media object
• Icon needs to be set for Object element

setCollectionRelation()

setCollectionRelation() 

Set relation Id for elements that will be registered in the Collection subnamespaces.