4764 lines
242 KiB
HTML
4764 lines
242 KiB
HTML
<!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">
|
|
Comment
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <a href="classes/PhpOffice-PhpWord-Element-TrackChange.html"><abbr title="\PhpOffice\PhpWord\Element\TrackChange">TrackChange</abbr></a>
|
|
</span>
|
|
|
|
|
|
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Element/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">27</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Comment 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">see</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-tag-list__definition">
|
|
<span class="phpdocumentor-tag-link"><a href="http://datypic.com/sc/ooxml/t-w_CT_Comment.html"><abbr title="http://datypic.com/sc/ooxml/t-w_CT_Comment.html">http://datypic.com/sc/ooxml/t-w_CT_Comment.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 -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#constant_DELETED">DELETED</a>
|
|
<span>
|
|
= 'DELETED' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -constant -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#constant_INSERTED">INSERTED</a>
|
|
<span>
|
|
= 'INSERTED' </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_collectionRelation">$collectionRelation</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Is part of collection.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_commentRangeEnd">$commentRangeEnd</a>
|
|
<span>
|
|
: <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>
|
|
: <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-AbstractContainer.html#property_container">$container</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Container type Section|Header|Footer|Footnote|Endnote|Cell|TextRun|TextBox|ListItemRun|TrackChange.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_docPart">$docPart</a>
|
|
<span>
|
|
: 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>
|
|
: 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>
|
|
: 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>
|
|
: 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-AbstractContainer.html#property_elements">$elements</a>
|
|
<span>
|
|
: array<string|int, <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>> </span>
|
|
</dt>
|
|
<dd>Elements collection.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_mediaRelation">$mediaRelation</a>
|
|
<span>
|
|
: 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-AbstractElement.html#property_phpWord">$phpWord</a>
|
|
<span>
|
|
: <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-AbstractElement.html#property_relationId">$relationId</a>
|
|
<span>
|
|
: 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>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Section Id.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_author">$author</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Author.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_changeType">$changeType</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>The type of change, (insert or delete), not applicable for PhpOffice\PhpWord\Element\Comment.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_date">$date</a>
|
|
<span>
|
|
: <abbr title="\DateTime">DateTime</abbr> </span>
|
|
</dt>
|
|
<dd>Date.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_endElement">$endElement</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>The Element where this comment ends.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_initials">$initials</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Initials.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_nestedLevel">$nestedLevel</a>
|
|
<span>
|
|
: 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>
|
|
: 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>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Parent container type.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_startElement">$startElement</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>The Element where this comment starts.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#property_trackChange">$trackChange</a>
|
|
<span>
|
|
: <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-AbstractContainer.html#method___call">__call()</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Magic method to catch all 'addElement' variation.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Create a new Comment Element.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addBookmark">addBookmark()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addChart">addChart()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addCheckBox">addCheckBox()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addEndnote">addEndnote()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addField">addField()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addFootnote">addFootnote()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addFormField">addFormField()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addImage">addImage()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addLine">addLine()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addLink">addLink()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addListItem">addListItem()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addListItemRun">addListItemRun()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addObject">addObject()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addOLEObject">addOLEObject()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addPageBreak">addPageBreak()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addPreserveText">addPreserveText()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addSDT">addSDT()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addShape">addShape()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTable">addTable()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addText">addText()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextBox">addTextBox()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextBreak">addTextBreak()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextRun">addTextRun()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTitle">addTitle()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTOC">addTOC()</a>
|
|
<span>
|
|
: <a href=""><abbr title=""></abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_countElements">countElements()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Count elements.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#method_getAuthor">getAuthor()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get TrackChange Author.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#method_getChangeType">getChangeType()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get the Change type.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getCommentRangeEnd">getCommentRangeEnd()</a>
|
|
<span>
|
|
: <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>
|
|
: <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-TrackChange.html#method_getDate">getDate()</a>
|
|
<span>
|
|
: <abbr title="\DateTime">DateTime</abbr> </span>
|
|
</dt>
|
|
<dd>Get TrackChange Date.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getDocPart">getDocPart()</a>
|
|
<span>
|
|
: 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>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get doc part Id.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_getElement">getElement()</a>
|
|
<span>
|
|
: null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Returns the element at the requested position.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getElementId">getElementId()</a>
|
|
<span>
|
|
: 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>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get element index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_getElements">getElements()</a>
|
|
<span>
|
|
: array<string|int, <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>> </span>
|
|
</dt>
|
|
<dd>Get all elements.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getEndElement">getEndElement()</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Get the element where this comment ends.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getInitials">getInitials()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Get Initials.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getNestedLevel">getNestedLevel()</a>
|
|
<span>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get nested level.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getParent">getParent()</a>
|
|
<span>
|
|
: 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>
|
|
: <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-AbstractElement.html#method_getRelationId">getRelationId()</a>
|
|
<span>
|
|
: 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>
|
|
: int </span>
|
|
</dt>
|
|
<dd>Get section number.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getStartElement">getStartElement()</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Get the element where this comment starts.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getTrackChange">getTrackChange()</a>
|
|
<span>
|
|
: <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-AbstractElement.html#method_isInSection">isInSection()</a>
|
|
<span>
|
|
: 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-AbstractContainer.html#method_removeElement">removeElement()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Removes the element at requested index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setChangeInfo">setChangeInfo()</a>
|
|
<span>
|
|
: 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>
|
|
: 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>
|
|
: 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>
|
|
: 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>
|
|
: 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>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set element index.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_setEndElement">setEndElement()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Sets the element where this comment ends.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setParentContainer">setParentContainer()</a>
|
|
<span>
|
|
: 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>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set PhpWord as reference.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setRelationId">setRelationId()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set relation Id.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_setStartElement">setStartElement()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Sets the element where this comment starts.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setTrackChange">setTrackChange()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Sets the trackChange information.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addElement">addElement()</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Add element.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_setEnumVal">setEnumVal()</a>
|
|
<span>
|
|
: 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>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Set new style value.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_checkValidity">checkValidity()</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Check if a method is allowed for the current container.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -private">
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html#method_getMediaPart">getMediaPart()</a>
|
|
<span>
|
|
: 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>
|
|
: 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>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set relation Id for media elements (link, image, object; legacy of OOXML).</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-constants">
|
|
<h3 class="phpdocumentor-elements__header" id="constants">
|
|
Constants
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_DELETED">
|
|
DELETED
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#constant_DELETED" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">31</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">DELETED</span>
|
|
= <span class="phpdocumentor-signature__default-value">'DELETED'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
<article class="phpdocumentor-element -constant -public ">
|
|
<h4 class="phpdocumentor-element__name" id="constant_INSERTED">
|
|
INSERTED
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#constant_INSERTED" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">30</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-signature phpdocumentor-code ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__type">mixed</span>
|
|
<span class="phpdocumentor-signature__name">INSERTED</span>
|
|
= <span class="phpdocumentor-signature__default-value">'INSERTED'</span>
|
|
</code>
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</section>
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.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-Comment.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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">55</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Is part of collection.</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">true</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_container">
|
|
$container
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#property_container" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">68</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Container type Section|Header|Footer|Footnote|Endnote|Cell|TextRun|TextBox|ListItemRun|TrackChange.</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">$container</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">'Section'</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_elements">
|
|
$elements
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#property_elements" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">61</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Elements collection.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type">array<string|int, <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>></span>
|
|
<span class="phpdocumentor-signature__name">$elements</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_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_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_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
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_author">
|
|
$author
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_author" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Author.</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">$author</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_changeType">
|
|
$changeType
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_changeType" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The type of change, (insert or delete), not applicable for PhpOffice\PhpWord\Element\Comment.</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">$changeType</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_date">
|
|
$date
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#property_date" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">57</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Date.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\DateTime">DateTime</abbr></span>
|
|
<span class="phpdocumentor-signature__name">$date</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_endElement">
|
|
$endElement
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_endElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">48</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The Element where this comment ends.</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-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$endElement</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_initials">
|
|
$initials
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_initials" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">34</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Initials.</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">$initials</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_startElement">
|
|
$startElement
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#property_startElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">41</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">The Element where this comment starts.</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-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$startElement</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-Comment.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___call">
|
|
__call()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method___call" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">83</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Magic method to catch all 'addElement' variation.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">__call</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$function</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$args</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>This removes addText, addTextRun, etc. When adding new element, we have to
|
|
add the model in the class docblock with <code class="prettyprint">@method</code>.</p>
|
|
<p>Warning: This makes capitalization matters, e.g. addCheckbox or addcheckbox won't work.</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">$function</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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">$args</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create a new Comment 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 class="phpdocumentor-signature__argument__return-type">string </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> </span><span class="phpdocumentor-signature__argument__name">$date</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">string </span><span class="phpdocumentor-signature__argument__name">$initials</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">$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></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">$initials</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">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addBookmark">
|
|
addBookmark()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addBookmark" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addBookmark</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addChart">
|
|
addChart()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addChart" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addChart</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$categories</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$values</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$seriesName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$categories</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$values</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$seriesName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addCheckBox">
|
|
addCheckBox()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addCheckBox" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addCheckBox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$text</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addEndnote">
|
|
addEndnote()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addEndnote" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addEndnote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addField">
|
|
addField()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addField" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addField</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed> </span><span class="phpdocumentor-signature__argument__name">$properties = array(</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>, array $options = array(), mixed $text = null)</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">$type = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$properties = array(</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">array<string|int, mixed></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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addFootnote">
|
|
addFootnote()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addFootnote" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addFootnote</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addFormField">
|
|
addFormField()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addFormField" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addFormField</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addImage">
|
|
addImage()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addImage" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addImage</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$source</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$isWatermark = false</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$name</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$source</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$isWatermark = false</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$name</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addLine">
|
|
addLine()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addLine" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addLine</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$lineStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$lineStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addLink">
|
|
addLink()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addLink" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addLink</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$target</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool </span><span class="phpdocumentor-signature__argument__name">$internal = false</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$target</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$text = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$internal = false</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">bool</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addListItem">
|
|
addListItem()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addListItem" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addListItem</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$txt</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$depth = 0</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$font = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$list = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$para = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$txt</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$depth = 0</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$font = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$list = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$para = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addListItemRun">
|
|
addListItemRun()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addListItemRun" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addListItemRun</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$depth = 0</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$listStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$depth = 0</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$listStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addObject">
|
|
addObject()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addObject" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addObject</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$source</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></abbr></a></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>deprecated, use addOLEObject instead</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">$source</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addOLEObject">
|
|
addOLEObject()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addOLEObject" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addOLEObject</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$source</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$source</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addPageBreak">
|
|
addPageBreak()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addPageBreak" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addPageBreak</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addPreserveText">
|
|
addPreserveText()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addPreserveText" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addPreserveText</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addSDT">
|
|
addSDT()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addSDT" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addSDT</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addShape">
|
|
addShape()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addShape" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addShape</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$type</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$type</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTable">
|
|
addTable()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTable" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTable</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addText">
|
|
addText()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addText" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addText</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTextBox">
|
|
addTextBox()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextBox" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTextBox</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$style = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$style = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTextBreak">
|
|
addTextBreak()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextBreak" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTextBreak</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$count = 1</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$count = 1</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$fStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTextRun">
|
|
addTextRun()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTextRun" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTextRun</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$pStyle = null</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$pStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTitle">
|
|
addTitle()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTitle" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTitle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$text</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$depth = 1</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$depth = 1</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addTOC">
|
|
addTOC()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addTOC" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">0</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">addTOC</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$fontStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed </span><span class="phpdocumentor-signature__argument__name">$tocStyle = null</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$minDepth = 1</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$maxDepth = 9</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href=""><abbr title=""></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">$fontStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$tocStyle = null</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">mixed</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$minDepth = 1</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$maxDepth = 9</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int</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"><a href=""><abbr title=""></abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_countElements">
|
|
countElements()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_countElements" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">213</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Count elements.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">countElements</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getAuthor">
|
|
getAuthor()
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#method_getAuthor" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">80</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get TrackChange Author.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getAuthor</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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getChangeType">
|
|
getChangeType()
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#method_getChangeType" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">100</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the Change type.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getChangeType</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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getDate">
|
|
getDate()
|
|
<a href="classes/PhpOffice-PhpWord-Element-TrackChange.html#method_getDate" 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/TrackChange.php"><a href="files/src-phpword-element-trackchange.html"><abbr title="src/PhpWord/Element/TrackChange.php">TrackChange.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">90</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get TrackChange Date.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getDate</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><abbr title="\DateTime">DateTime</abbr></span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
|
|
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
|
|
<span class="phpdocumentor-signature__response_type"><abbr title="\DateTime">DateTime</abbr></span>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getElement">
|
|
getElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_getElement" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">179</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Returns the element at the requested position.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getElement</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int </span><span class="phpdocumentor-signature__argument__name">$index</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-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$index</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">null|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getElements">
|
|
getElements()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_getElements" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">167</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get all elements.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getElements</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array<string|int, <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">array<string|int, <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a>></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getEndElement">
|
|
getEndElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getEndElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">121</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the element where this comment ends.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getEndElement</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getInitials">
|
|
getInitials()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getInitials" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">75</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get Initials.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getInitials</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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getStartElement">
|
|
getStartElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_getStartElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">98</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get the element where this comment starts.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">getStartElement</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><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"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_removeElement">
|
|
removeElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_removeElement" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">193</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Removes the element at requested index.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">removeElement</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|<a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$toRemove</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">$toRemove</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">int|<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>
|
|
—
|
|
<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 </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 </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 </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>
|
|
—
|
|
<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> </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>
|
|
—
|
|
<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> </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>
|
|
—
|
|
<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 </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 </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>
|
|
—
|
|
<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>
|
|
—
|
|
<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 </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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setEndElement">
|
|
setEndElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_setEndElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">108</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the element where this comment ends.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setEndElement</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> </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-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>
|
|
—
|
|
<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> </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>
|
|
—
|
|
<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> </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>
|
|
—
|
|
<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 </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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_setStartElement">
|
|
setStartElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-Comment.html#method_setStartElement" 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/Comment.php"><a href="files/src-phpword-element-comment.html"><abbr title="src/PhpWord/Element/Comment.php">Comment.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">85</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Sets the element where this comment starts.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setStartElement</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> </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-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>
|
|
—
|
|
<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> </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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_addElement">
|
|
addElement()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_addElement" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">132</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Add element.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">addElement</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$elementName</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span></code>
|
|
|
|
<section class="phpdocumentor-description"><p>Each element has different number of parameters passed</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">$elementName</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
—
|
|
<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 </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<string|int, string> </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 </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<string|int, string></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>
|
|
—
|
|
<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 </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 </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 </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>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-private
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_checkValidity">
|
|
checkValidity()
|
|
<a href="classes/PhpOffice-PhpWord-Element-AbstractContainer.html#method_checkValidity" 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/AbstractContainer.php"><a href="files/src-phpword-element-abstractcontainer.html"><abbr title="src/PhpWord/Element/AbstractContainer.php">AbstractContainer.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">225</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Check if a method is allowed for the current container.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">private</span>
|
|
<span class="phpdocumentor-signature__name">checkValidity</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string </span><span class="phpdocumentor-signature__argument__name">$method</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</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">$method</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type">string</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">bool</span>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<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>
|
|
—
|
|
<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-Comment.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
</body>
|
|
</html>
|