Documentation

FormField extends Text

in package

• Application

Form field element.

Tags

since

0.12.0

see

http://www.datypic.com/sc/ooxml/t-w_CT_FFData.html

Table of Contents

Properties

$collectionRelation  : bool

Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment.

$commentsRangeEnd  : Comments

The end position for the linked comments.

$commentsRangeStart  : Comments

The start position for the linked comments.

$docPart  : string

Document part type: Section|Header|Footer|Footnote|Endnote.

$docPartId  : int

Document part Id.

$elementId  : string

Unique Id for element.

$elementIndex  : int

Index of element in the elements collection (start with 1).

$fontStyle  : Font|string

Text style.

$mediaRelation  : bool

Has media relation flag; true for Link, Image, and Object.

$paragraphStyle  : Paragraph|string

Paragraph style.

$phpWord  : PhpWord|null

PhpWord object.

$relationId  : int

Relation Id.

$sectionId  : int

Section Id.

$text  : string|null

Text content.

$default  : bool|int|string

Default value.

$entries  : array<string|int, mixed>

Dropdown entries.

$name  : string|null

Form field name.

$nestedLevel  : int

Depth of table container nested level; Primarily used for RTF writer/reader.

$parent  : null|AbstractElement

A reference to the parent.

$parentContainer  : string

Parent container type.

$trackChange  : TrackChange

changed element info.

$type  : string

Form field type: textinput|checkbox|dropdown.

$value  : null|bool|int|string

Value.

Methods

__construct()  : mixed

Create new instance.

getCommentRangeEnd()  : Comment

Get comment end.

getCommentRangeStart()  : Comment

Get comment start.

getCommentsRangeEnd()  : Comments

Get comments end.

getCommentsRangeStart()  : Comments

Get comments start.

getDefault()  : bool|int|string

Get default.

getDocPart()  : string

Get doc part.

getDocPartId()  : int

Get doc part Id.

getElementId()  : string

Get element unique ID.

getElementIndex()  : int

Get element index.

getEntries()  : array<string|int, mixed>

Get entries.

getFontStyle()  : Font|string

Get Text style.

getName()  : string|null

Get name.

getNestedLevel()  : int

Get nested level.

getParagraphStyle()  : Paragraph|string

Get Paragraph style.

getParent()  : null|AbstractElement

Get parent element.

getPhpWord()  : PhpWord|null

Get PhpWord.

getRelationId()  : int

Get relation Id.

getSectionId()  : int

Get section number.

getText()  : string|null

Get Text content.

getTrackChange()  : TrackChange

Gets the trackChange information.

getType()  : string

Get type.

getValue()  : null|bool|int|string

Get value.

isInSection()  : bool

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

setChangeInfo()  : void

Set changed.

setCommentRangeEnd()  : void

Set comment end.

setCommentRangeStart()  : void

Set comment start.

setDefault()  : self

Set default.

setDocPart()  : void

Set doc part.

setElementId()  : void

Set element unique ID from 6 first digit of md5.

setElementIndex()  : void

Set element index.

setEntries()  : self

Set entries.

setFontStyle()  : Font|string

Set Text style.

setName()  : self

Set name.

setParagraphStyle()  : Paragraph|string

Set Paragraph style.

setParentContainer()  : void

Set parent container.

setPhpWord()  : void

Set PhpWord as reference.

setRelationId()  : void

Set relation Id.

setText()  : self

Set text content.

setTrackChange()  : void

Sets the trackChange information.

setType()  : self

Set type.

setValue()  : self

Set value.

setEnumVal()  : null|string

Set enum value.

setNewStyle()  : mixed

Set new style value.

getMediaPart()  : string

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

setCollectionRelation()  : void

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

setMediaRelation()  : void

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