PHPWord/classes/PhpOffice-PhpWord-Element-Field.html

2986 lines
147 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-element.html">Element</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Field
<span class="phpdocumentor-element__extends">
extends <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>
</span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">29</span>
</aside>
<p class="phpdocumentor-summary">Field element.</p>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">see</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="http://www.schemacentral.com/sc/ooxml/t-w_CT_SimpleField.html"><abbr title="http://www.schemacentral.com/sc/ooxml/t-w_CT_SimpleField.html">http://www.schemacentral.com/sc/ooxml/t-w_CT_SimpleField.html</abbr></a></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_collectionRelation">$collectionRelation</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_commentRangeEnd">$commentRangeEnd</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a> </span>
</dt>
<dd>The end position for the linked comment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_commentRangeStart">$commentRangeStart</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a> </span>
</dt>
<dd>The start position for the linked comment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_docPart">$docPart</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Document part type: Section|Header|Footer|Footnote|Endnote.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_docPartId">$docPartId</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Document part Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_elementId">$elementId</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Unique Id for element.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_elementIndex">$elementIndex</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Index of element in the elements collection (start with 1).</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_fieldsArray">$fieldsArray</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Field properties and options. Depending on type, a field can have different properties
and options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_fontStyle">$fontStyle</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string </span>
</dt>
<dd>Font style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_mediaRelation">$mediaRelation</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Has media relation flag; true for Link, Image, and Object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_options">$options</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Field options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_phpWord">$phpWord</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a> </span>
</dt>
<dd>PhpWord object.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_properties">$properties</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Field properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_relationId">$relationId</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Relation Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_sectionId">$sectionId</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Section Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_text">$text</a>
<span>
&nbsp;: string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a> </span>
</dt>
<dd>Field text.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_type">$type</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Field type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_nestedLevel">$nestedLevel</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Depth of table container nested level; Primarily used for RTF writer/reader.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_parent">$parent</a>
<span>
&nbsp;: null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
</dt>
<dd>A reference to the parent.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_parentContainer">$parentContainer</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Parent container type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_trackChange">$trackChange</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a> </span>
</dt>
<dd>changed element info.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Create a new Field Element.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getCommentRangeEnd">getCommentRangeEnd()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a> </span>
</dt>
<dd>Get comment end.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getCommentRangeStart">getCommentRangeStart()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a> </span>
</dt>
<dd>Get comment start.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getDocPart">getDocPart()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get doc part.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getDocPartId">getDocPartId()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get doc part Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getElementId">getElementId()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get element unique ID.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getElementIndex">getElementIndex()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get element index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getFontStyle">getFontStyle()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string </span>
</dt>
<dd>Get Font style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getNestedLevel">getNestedLevel()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get nested level.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getOptions">getOptions()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get Field properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getParent">getParent()</a>
<span>
&nbsp;: null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
</dt>
<dd>Get parent element.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getPhpWord">getPhpWord()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a> </span>
</dt>
<dd>Get PhpWord.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getProperties">getProperties()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get Field properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getRelationId">getRelationId()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get relation Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getSectionId">getSectionId()</a>
<span>
&nbsp;: int </span>
</dt>
<dd>Get section number.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getText">getText()</a>
<span>
&nbsp;: string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a> </span>
</dt>
<dd>Get Field text.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getTrackChange">getTrackChange()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a> </span>
</dt>
<dd>Gets the trackChange information.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getType">getType()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get Field type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_isInSection">isInSection()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Check if element is located in Section doc part (as opposed to Header/Footer).</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setChangeInfo">setChangeInfo()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set changed.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCommentRangeEnd">setCommentRangeEnd()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set comment end.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCommentRangeStart">setCommentRangeStart()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set comment start.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setDocPart">setDocPart()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set doc part.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setElementId">setElementId()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set element unique ID from 6 first digit of md5.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setElementIndex">setElementIndex()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set element index.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setFontStyle">setFontStyle()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string </span>
</dt>
<dd>Set Font style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setOptions">setOptions()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set Field options.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setParentContainer">setParentContainer()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set parent container.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setPhpWord">setPhpWord()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set PhpWord as reference.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setProperties">setProperties()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set Field properties.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setRelationId">setRelationId()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set relation Id.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setText">setText()</a>
<span>
&nbsp;: null|string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a> </span>
</dt>
<dd>Set Field text.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setTrackChange">setTrackChange()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Sets the trackChange information.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setType">setType()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Set Field type.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setEnumVal">setEnumVal()</a>
<span>
&nbsp;: null|string </span>
</dt>
<dd>Set enum value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setNewStyle">setNewStyle()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set new style value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getMediaPart">getMediaPart()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Return media element (image, object, link) container name.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCollectionRelation">setCollectionRelation()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set relation Id for elements that will be registered in the Collection subnamespaces.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setMediaRelation">setMediaRelation()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Set relation Id for media elements (link, image, object; legacy of OOXML).</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Element-Field.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_collectionRelation">
$collectionRelation
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_collectionRelation" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">131</span>
</aside>
<p class="phpdocumentor-summary">Is part of collection; true for Title, Footnote, Endnote, Chart, and Comment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$collectionRelation</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_commentRangeEnd">
$commentRangeEnd
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_commentRangeEnd" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">145</span>
</aside>
<p class="phpdocumentor-summary">The end position for the linked comment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
<span class="phpdocumentor-signature__name">$commentRangeEnd</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_commentRangeStart">
$commentRangeStart
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_commentRangeStart" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">138</span>
</aside>
<p class="phpdocumentor-summary">The start position for the linked comment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
<span class="phpdocumentor-signature__name">$commentRangeStart</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_docPart">
$docPart
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_docPart" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">55</span>
</aside>
<p class="phpdocumentor-summary">Document part type: Section|Header|Footer|Footnote|Endnote.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$docPart</span>
= <span class="phpdocumentor-signature__default-value">&#039;Section&#039;</span></code>
<section class="phpdocumentor-description"><p>Used by textrun and cell container to determine where the element is
located because it will affect the availability of other element,
e.g. footnote will not be available when $docPart is header or footer.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_docPartId">
$docPartId
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_docPartId" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">66</span>
</aside>
<p class="phpdocumentor-summary">Document part Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$docPartId</span>
= <span class="phpdocumentor-signature__default-value">1</span></code>
<section class="phpdocumentor-description"><p>For header and footer, this will be = ($sectionId - 1) * 3 + $index
because the max number of header/footer in every page is 3, i.e.
AUTO, FIRST, and EVEN (AUTO = ODD)</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_elementId">
$elementId
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_elementId" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">80</span>
</aside>
<p class="phpdocumentor-summary">Unique Id for element.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$elementId</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_elementIndex">
$elementIndex
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_elementIndex" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">73</span>
</aside>
<p class="phpdocumentor-summary">Index of element in the elements collection (start with 1).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$elementIndex</span>
= <span class="phpdocumentor-signature__default-value">1</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_fieldsArray">
$fieldsArray
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_fieldsArray" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">Field properties and options. Depending on type, a field can have different properties
and options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$fieldsArray</span>
= <span class="phpdocumentor-signature__default-value">[&#039;PAGE&#039; =&gt; [&#039;properties&#039; =&gt; [&#039;format&#039; =&gt; [&#039;Arabic&#039;, &#039;ArabicDash&#039;, &#039;alphabetic&#039;, &#039;ALPHABETIC&#039;, &#039;roman&#039;, &#039;ROMAN&#039;]], &#039;options&#039; =&gt; [&#039;PreserveFormat&#039;]], &#039;NUMPAGES&#039; =&gt; [&#039;properties&#039; =&gt; [&#039;format&#039; =&gt; [&#039;Arabic&#039;, &#039;ArabicDash&#039;, &#039;CardText&#039;, &#039;DollarText&#039;, &#039;Ordinal&#039;, &#039;OrdText&#039;, &#039;alphabetic&#039;, &#039;ALPHABETIC&#039;, &#039;roman&#039;, &#039;ROMAN&#039;, &#039;Caps&#039;, &#039;FirstCap&#039;, &#039;Lower&#039;, &#039;Upper&#039;], &#039;numformat&#039; =&gt; [&#039;0&#039;, &#039;0,00&#039;, &#039;#.##0&#039;, &#039;#.##0,00&#039;, &#039;€ #.##0,00(€ #.##0,00)&#039;, &#039;0%&#039;, &#039;0,00%&#039;]], &#039;options&#039; =&gt; [&#039;PreserveFormat&#039;]], &#039;DATE&#039; =&gt; [&#039;properties&#039; =&gt; [&#039;dateformat&#039; =&gt; [
// Generic formats
&#039;yyyy-MM-dd&#039;,
&#039;yyyy-MM&#039;,
&#039;MMM-yy&#039;,
&#039;MMM-yyyy&#039;,
&#039;h:mm am/pm&#039;,
&#039;h:mm:ss am/pm&#039;,
&#039;HH:mm&#039;,
&#039;HH:mm:ss&#039;,
// Day-Month-Year formats
&#039;dddd d MMMM yyyy&#039;,
&#039;d MMMM yyyy&#039;,
&#039;d-MMM-yy&#039;,
&#039;d MMM. yy&#039;,
&#039;d-M-yy&#039;,
&#039;d-M-yy h:mm&#039;,
&#039;d-M-yy h:mm:ss&#039;,
&#039;d-M-yy h:mm am/pm&#039;,
&#039;d-M-yy h:mm:ss am/pm&#039;,
&#039;d-M-yy HH:mm&#039;,
&#039;d-M-yy HH:mm:ss&#039;,
&#039;d/M/yy&#039;,
&#039;d/M/yy h:mm&#039;,
&#039;d/M/yy h:mm:ss&#039;,
&#039;d/M/yy h:mm am/pm&#039;,
&#039;d/M/yy h:mm:ss am/pm&#039;,
&#039;d/M/yy HH:mm&#039;,
&#039;d/M/yy HH:mm:ss&#039;,
&#039;d-M-yyyy&#039;,
&#039;d-M-yyyy h:mm&#039;,
&#039;d-M-yyyy h:mm:ss&#039;,
&#039;d-M-yyyy h:mm am/pm&#039;,
&#039;d-M-yyyy h:mm:ss am/pm&#039;,
&#039;d-M-yyyy HH:mm&#039;,
&#039;d-M-yyyy HH:mm:ss&#039;,
&#039;d/M/yyyy&#039;,
&#039;d/M/yyyy h:mm&#039;,
&#039;d/M/yyyy h:mm:ss&#039;,
&#039;d/M/yyyy h:mm am/pm&#039;,
&#039;d/M/yyyy h:mm:ss am/pm&#039;,
&#039;d/M/yyyy HH:mm&#039;,
&#039;d/M/yyyy HH:mm:ss&#039;,
// Month-Day-Year formats
&#039;dddd, MMMM d yyyy&#039;,
&#039;MMMM d yyyy&#039;,
&#039;MMM-d-yy&#039;,
&#039;MMM. d yy&#039;,
&#039;M-d-yy&#039;,
&#039;M-d-yy h:mm&#039;,
&#039;M-d-yy h:mm:ss&#039;,
&#039;M-d-yy h:mm am/pm&#039;,
&#039;M-d-yy h:mm:ss am/pm&#039;,
&#039;M-d-yy HH:mm&#039;,
&#039;M-d-yy HH:mm:ss&#039;,
&#039;M/d/yy&#039;,
&#039;M/d/yy h:mm&#039;,
&#039;M/d/yy h:mm:ss&#039;,
&#039;M/d/yy h:mm am/pm&#039;,
&#039;M/d/yy h:mm:ss am/pm&#039;,
&#039;M/d/yy HH:mm&#039;,
&#039;M/d/yy HH:mm:ss&#039;,
&#039;M-d-yyyy&#039;,
&#039;M-d-yyyy h:mm&#039;,
&#039;M-d-yyyy h:mm:ss&#039;,
&#039;M-d-yyyy h:mm am/pm&#039;,
&#039;M-d-yyyy h:mm:ss am/pm&#039;,
&#039;M-d-yyyy HH:mm&#039;,
&#039;M-d-yyyy HH:mm:ss&#039;,
&#039;M/d/yyyy&#039;,
&#039;M/d/yyyy h:mm&#039;,
&#039;M/d/yyyy h:mm:ss&#039;,
&#039;M/d/yyyy h:mm am/pm&#039;,
&#039;M/d/yyyy h:mm:ss am/pm&#039;,
&#039;M/d/yyyy HH:mm&#039;,
&#039;M/d/yyyy HH:mm:ss&#039;,
]], &#039;options&#039; =&gt; [&#039;PreserveFormat&#039;, &#039;LunarCalendar&#039;, &#039;SakaEraCalendar&#039;, &#039;LastUsedFormat&#039;]], &#039;MACROBUTTON&#039; =&gt; [&#039;properties&#039; =&gt; [&#039;macroname&#039; =&gt; &#039;&#039;]], &#039;XE&#039; =&gt; [&#039;properties&#039; =&gt; [], &#039;options&#039; =&gt; [&#039;Bold&#039;, &#039;Italic&#039;]], &#039;INDEX&#039; =&gt; [&#039;properties&#039; =&gt; [], &#039;options&#039; =&gt; [&#039;PreserveFormat&#039;]], &#039;STYLEREF&#039; =&gt; [&#039;properties&#039; =&gt; [&#039;StyleIdentifier&#039; =&gt; &#039;&#039;], &#039;options&#039; =&gt; [&#039;PreserveFormat&#039;]]]</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_fontStyle">
$fontStyle
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_fontStyle" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">123</span>
</aside>
<p class="phpdocumentor-summary">Font style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span>
<span class="phpdocumentor-signature__name">$fontStyle</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_mediaRelation">
$mediaRelation
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_mediaRelation" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">124</span>
</aside>
<p class="phpdocumentor-summary">Has media relation flag; true for Link, Image, and Object.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$mediaRelation</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_options">
$options
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_options" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">116</span>
</aside>
<p class="phpdocumentor-summary">Field options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$options</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_phpWord">
$phpWord
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_phpWord" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">37</span>
</aside>
<p class="phpdocumentor-summary">PhpWord object.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
<span class="phpdocumentor-signature__name">$phpWord</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_properties">
$properties
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_properties" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">109</span>
</aside>
<p class="phpdocumentor-summary">Field properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$properties</span>
= <span class="phpdocumentor-signature__default-value">[]</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_relationId">
$relationId
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_relationId" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">87</span>
</aside>
<p class="phpdocumentor-summary">Relation Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$relationId</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_sectionId">
$sectionId
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_sectionId" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">44</span>
</aside>
<p class="phpdocumentor-summary">Section Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$sectionId</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_text">
$text
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_text" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">102</span>
</aside>
<p class="phpdocumentor-summary">Field text.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span>
<span class="phpdocumentor-signature__name">$text</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_type">
$type
<a href="classes/PhpOffice-PhpWord-Element-Field.html#property_type" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">95</span>
</aside>
<p class="phpdocumentor-summary">Field type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$type</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_nestedLevel">
$nestedLevel
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_nestedLevel" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">96</span>
</aside>
<p class="phpdocumentor-summary">Depth of table container nested level; Primarily used for RTF writer/reader.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">int</span>
<span class="phpdocumentor-signature__name">$nestedLevel</span>
= <span class="phpdocumentor-signature__default-value">0</span></code>
<section class="phpdocumentor-description"><p>0 = Not in a table; 1 = in a table; 2 = in a table inside another table, etc.</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_parent">
$parent
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_parent" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">103</span>
</aside>
<p class="phpdocumentor-summary">A reference to the parent.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
<span class="phpdocumentor-signature__name">$parent</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_parentContainer">
$parentContainer
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_parentContainer" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">117</span>
</aside>
<p class="phpdocumentor-summary">Parent container type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">string</span>
<span class="phpdocumentor-signature__name">$parentContainer</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_trackChange">
$trackChange
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_trackChange" class="headerlink"><i class="fas fa-link"></i></a>
<span class="phpdocumentor-element__modifiers">
</span>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">110</span>
</aside>
<p class="phpdocumentor-summary">changed element info.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a></span>
<span class="phpdocumentor-signature__name">$trackChange</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
</section>
<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/PhpOffice-PhpWord-Element-Field.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method___construct">
__construct()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method___construct" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">167</span>
</aside>
<p class="phpdocumentor-summary">Create a new Field Element.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">__construct</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">null|string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$text</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|<a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$fontStyle</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$properties</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">null|string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$fontStyle</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|<a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCommentRangeEnd">
getCommentRangeEnd()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getCommentRangeEnd" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">319</span>
</aside>
<p class="phpdocumentor-summary">Get comment end.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCommentRangeEnd</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getCommentRangeStart">
getCommentRangeStart()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getCommentRangeStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">297</span>
</aside>
<p class="phpdocumentor-summary">Get comment start.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getCommentRangeStart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDocPart">
getDocPart()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getDocPart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">194</span>
</aside>
<p class="phpdocumentor-summary">Get doc part.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDocPart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getDocPartId">
getDocPartId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getDocPartId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">204</span>
</aside>
<p class="phpdocumentor-summary">Get doc part Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getDocPartId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getElementId">
getElementId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getElementId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">249</span>
</aside>
<p class="phpdocumentor-summary">Get element unique ID.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getElementId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getElementIndex">
getElementIndex()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getElementIndex" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">229</span>
</aside>
<p class="phpdocumentor-summary">Get element index.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getElementIndex</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getFontStyle">
getFontStyle()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getFontStyle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">153</span>
</aside>
<p class="phpdocumentor-summary">Get Font style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getFontStyle</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getNestedLevel">
getNestedLevel()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getNestedLevel" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">287</span>
</aside>
<p class="phpdocumentor-summary">Get nested level.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getNestedLevel</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getOptions">
getOptions()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getOptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">263</span>
</aside>
<p class="phpdocumentor-summary">Get Field properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getOptions</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getParent">
getParent()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getParent" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">341</span>
</aside>
<p class="phpdocumentor-summary">Get parent element.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getParent</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getPhpWord">
getPhpWord()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getPhpWord" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">152</span>
</aside>
<p class="phpdocumentor-summary">Get PhpWord.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getPhpWord</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getProperties">
getProperties()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getProperties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">232</span>
</aside>
<p class="phpdocumentor-summary">Get Field properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getProperties</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getRelationId">
getRelationId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getRelationId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">267</span>
</aside>
<p class="phpdocumentor-summary">Get relation Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getRelationId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSectionId">
getSectionId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getSectionId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">172</span>
</aside>
<p class="phpdocumentor-summary">Get section number.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSectionId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getText">
getText()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getText" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">293</span>
</aside>
<p class="phpdocumentor-summary">Get Field text.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getText</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getTrackChange">
getTrackChange()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getTrackChange" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">465</span>
</aside>
<p class="phpdocumentor-summary">Gets the trackChange information.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getTrackChange</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getType">
getType()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_getType" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">201</span>
</aside>
<p class="phpdocumentor-summary">Get Field type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getType</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isInSection">
isInSection()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_isInSection" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">426</span>
</aside>
<p class="phpdocumentor-summary">Check if element is located in Section doc part (as opposed to Header/Footer).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isInSection</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setChangeInfo">
setChangeInfo()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setChangeInfo" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">477</span>
</aside>
<p class="phpdocumentor-summary">Set changed.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setChangeInfo</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$author</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">null|<abbr title="\DateTime">DateTime</abbr>|int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$date</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>INSERTED|DELETED</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$author</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$date</span>
: <span class="phpdocumentor-signature__argument__return-type">null|<abbr title="\DateTime">DateTime</abbr>|int</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>allways in UTC</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setCommentRangeEnd">
setCommentRangeEnd()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCommentRangeEnd" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">327</span>
</aside>
<p class="phpdocumentor-summary">Set comment end.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setCommentRangeEnd</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setCommentRangeStart">
setCommentRangeStart()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCommentRangeStart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">305</span>
</aside>
<p class="phpdocumentor-summary">Set comment start.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setCommentRangeStart</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Comment.html"><abbr title="\PhpOffice\PhpWord\Element\Comment">Comment</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setDocPart">
setDocPart()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setDocPart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
</aside>
<p class="phpdocumentor-summary">Set doc part.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setDocPart</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$docPart</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$docPartId</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">1</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$docPart</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$docPartId</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
= <span class="phpdocumentor-signature__argument__default-value">1</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setElementId">
setElementId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setElementId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">257</span>
</aside>
<p class="phpdocumentor-summary">Set element unique ID from 6 first digit of md5.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setElementId</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setElementIndex">
setElementIndex()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setElementIndex" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">239</span>
</aside>
<p class="phpdocumentor-summary">Set element index.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setElementIndex</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setFontStyle">
setFontStyle()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setFontStyle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">132</span>
</aside>
<p class="phpdocumentor-summary">Set Font style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setFontStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|<a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$style</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;|<a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a>|string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setOptions">
setOptions()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setOptions" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">244</span>
</aside>
<p class="phpdocumentor-summary">Set Field options.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setOptions</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$options</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$options</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setParentContainer">
setParentContainer()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setParentContainer" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">353</span>
</aside>
<p class="phpdocumentor-summary">Set parent container.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setParentContainer</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$container</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><p>Passed parameter should be a container, except for Table (contain Row) and Row (contain Cell)</p>
</section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$container</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setPhpWord">
setPhpWord()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setPhpWord" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">162</span>
</aside>
<p class="phpdocumentor-summary">Set PhpWord as reference.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setPhpWord</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$phpWord</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$phpWord</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-PhpWord.html"><abbr title="\PhpOffice\PhpWord\PhpWord">PhpWord</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setProperties">
setProperties()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setProperties" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">213</span>
</aside>
<p class="phpdocumentor-summary">Set Field properties.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setProperties</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$properties</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setRelationId">
setRelationId()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setRelationId" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">277</span>
</aside>
<p class="phpdocumentor-summary">Set relation Id.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setRelationId</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setText">
setText()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setText" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">275</span>
</aside>
<p class="phpdocumentor-summary">Set Field text.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setText</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$text</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null|string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$text</span>
: <span class="phpdocumentor-signature__argument__return-type">string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null|string|<a href="classes/PhpOffice-PhpWord-Element-TextRun.html"><abbr title="\PhpOffice\PhpWord\Element\TextRun">TextRun</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setTrackChange">
setTrackChange()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setTrackChange" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">455</span>
</aside>
<p class="phpdocumentor-summary">Sets the trackChange information.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setTrackChange</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$trackChange</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$trackChange</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setType">
setType()
<a href="classes/PhpOffice-PhpWord-Element-Field.html#method_setType" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Field.php"><a href="files/src-phpword-element-field.html"><abbr title="src/PhpWord/Element/Field.php">Field.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">183</span>
</aside>
<p class="phpdocumentor-summary">Set Field type.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setType</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$type</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$type</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setEnumVal">
setEnumVal()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setEnumVal" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">493</span>
</aside>
<p class="phpdocumentor-summary">Set enum value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setEnumVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">null|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$enum</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">null|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null|string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">null|string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$enum</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, string&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">null|string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">todo</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"><p>Merge with the same method in AbstractStyle</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null|string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setNewStyle">
setNewStyle()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setNewStyle" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">440</span>
</aside>
<p class="phpdocumentor-summary">Set new style value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setNewStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleObject</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleValue</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$returnObject</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">false</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styleObject</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Style object</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styleValue</span>
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Style value</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$returnObject</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">false</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Always return object</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_getMediaPart">
getMediaPart()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getMediaPart" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">214</span>
</aside>
<p class="phpdocumentor-summary">Return media element (image, object, link) container name.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">getMediaPart</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>section|headerx|footerx|footnote|endnote</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_setCollectionRelation">
setCollectionRelation()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setCollectionRelation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">411</span>
</aside>
<p class="phpdocumentor-summary">Set relation Id for elements that will be registered in the Collection subnamespaces.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">setCollectionRelation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_setMediaRelation">
setMediaRelation()
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setMediaRelation" class="headerlink"><i class="fas fa-link"></i></a>
</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/AbstractElement.php"><a href="files/src-phpword-element-abstractelement.html"><abbr title="src/PhpWord/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">382</span>
</aside>
<p class="phpdocumentor-summary">Set relation Id for media elements (link, image, object; legacy of OOXML).</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">setMediaRelation</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"><ul>
<li>Image element needs to be passed to Media object</li>
<li>Icon needs to be set for Object element</li>
</ul>
</section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Element-Field.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>