899 lines
43 KiB
HTML
899 lines
43 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-writer.html">Writer</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-rtf.html">RTF</a></li>
|
|
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-rtf-element.html">Element</a></li>
|
|
</ul>
|
|
|
|
<article class="phpdocumentor-element -class">
|
|
<h2 class="phpdocumentor-content__title">
|
|
Field
|
|
|
|
<span class="phpdocumentor-element__extends">
|
|
extends <a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Text.html"><abbr title="\PhpOffice\PhpWord\Writer\RTF\Element\Text">Text</abbr></a>
|
|
</span>
|
|
|
|
|
|
|
|
</h2>
|
|
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/RTF/Element/Field.php"><a href="files/src-phpword-writer-rtf-element-field.html"><abbr title="src/PhpWord/Writer/RTF/Element/Field.php">Field.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">25</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Field element writer.</p>
|
|
|
|
<section class="phpdocumentor-description"><p>Note: for now, only date, page and numpages fields are implemented for RTF.</p>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 id="toc">
|
|
Table of Contents
|
|
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
|
|
<dl class="phpdocumentor-table-of-contents">
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_element">$element</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Element-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a> </span>
|
|
</dt>
|
|
<dd>Element.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_escaper">$escaper</a>
|
|
<span>
|
|
: <abbr title="\Laminas\Escaper\Escaper">Escaper</abbr>|<a href="classes/PhpOffice-PhpWord-Escaper-AbstractEscaper.html"><abbr title="\PhpOffice\PhpWord\Escaper\AbstractEscaper">AbstractEscaper</abbr></a> </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#property_fontStyle">$fontStyle</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a> </span>
|
|
</dt>
|
|
<dd>Font style.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#property_paragraphStyle">$paragraphStyle</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Style-Paragraph.html"><abbr title="\PhpOffice\PhpWord\Style\Paragraph">Paragraph</abbr></a> </span>
|
|
</dt>
|
|
<dd>Paragraph style.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_parentWriter">$parentWriter</a>
|
|
<span>
|
|
: <a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a> </span>
|
|
</dt>
|
|
<dd>Parent writer.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_withoutP">$withoutP</a>
|
|
<span>
|
|
: bool </span>
|
|
</dt>
|
|
<dd>Without paragraph.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#method___construct">__construct()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd>Create new instance.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#method_setWithoutP">setWithoutP()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Set without paragraph.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -public">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_write">write()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Write field element.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_getStyles">getStyles()</a>
|
|
<span>
|
|
: void </span>
|
|
</dt>
|
|
<dd>Get font and paragraph styles.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeClosing">writeClosing()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Write closing.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writeDate">writeDate()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeFontStyle">writeFontStyle()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Write font style.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writeNumpages">writeNumpages()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeOpening">writeOpening()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Write opening.</dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writePage">writePage()</a>
|
|
<span>
|
|
: mixed </span>
|
|
</dt>
|
|
<dd></dd>
|
|
|
|
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeText">writeText()</a>
|
|
<span>
|
|
: string </span>
|
|
</dt>
|
|
<dd>Write text.</dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="phpdocumentor-properties">
|
|
<h3 class="phpdocumentor-elements__header" id="properties">
|
|
Properties
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#properties" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_element">
|
|
$element
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_element" 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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">43</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Element.</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-AbstractElement.html"><abbr title="\PhpOffice\PhpWord\Element\AbstractElement">AbstractElement</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$element</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_escaper">
|
|
$escaper
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_escaper" 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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">55</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><abbr title="\Laminas\Escaper\Escaper">Escaper</abbr>|<a href="classes/PhpOffice-PhpWord-Escaper-AbstractEscaper.html"><abbr title="\PhpOffice\PhpWord\Escaper\AbstractEscaper">AbstractEscaper</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$escaper</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_fontStyle">
|
|
$fontStyle
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#property_fontStyle" class="headerlink"><i class="fas fa-link"></i></a>
|
|
<span class="phpdocumentor-element__modifiers">
|
|
</span>
|
|
</h4>
|
|
<aside class="phpdocumentor-element-found-in">
|
|
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">44</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Font style.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Style-Font.html"><abbr title="\PhpOffice\PhpWord\Style\Font">Font</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$fontStyle</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_paragraphStyle">
|
|
$paragraphStyle
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#property_paragraphStyle" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">51</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Paragraph style.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Style-Paragraph.html"><abbr title="\PhpOffice\PhpWord\Style\Paragraph">Paragraph</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$paragraphStyle</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_parentWriter">
|
|
$parentWriter
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_parentWriter" 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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">36</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Parent writer.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span>
|
|
<span class="phpdocumentor-signature__name">$parentWriter</span>
|
|
</code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="
|
|
phpdocumentor-element
|
|
-property
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="property_withoutP">
|
|
$withoutP
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#property_withoutP" 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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">50</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Without paragraph.</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">$withoutP</span>
|
|
= <span class="phpdocumentor-signature__default-value">false</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-Writer-RTF-Element-Field.html#methods" class="headerlink"><i class="fas fa-link"></i></a>
|
|
</h3>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-public
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method___construct">
|
|
__construct()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">67</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Create new instance.</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"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$parentWriter</span></span><span class="phpdocumentor-signature__argument"><span>, </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><span class="phpdocumentor-signature__argument__name">$element</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">$withoutP</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">$parentWriter</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Writer-AbstractWriter.html"><abbr title="\PhpOffice\PhpWord\Writer\AbstractWriter">AbstractWriter</abbr></a></span>
|
|
</dt>
|
|
<dd class="phpdocumentor-argument-list__definition">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$element</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">
|
|
|
|
</dd>
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$withoutP</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"></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_setWithoutP">
|
|
setWithoutP()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-HTML-Element-AbstractElement.html#method_setWithoutP" 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/Writer/HTML/Element/AbstractElement.php"><a href="files/src-phpword-writer-html-element-abstractelement.html"><abbr title="src/PhpWord/Writer/HTML/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">80</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Set without paragraph.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">setWithoutP</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool </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">bool</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_write">
|
|
write()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_write" 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/Writer/RTF/Element/Field.php"><a href="files/src-phpword-writer-rtf-element-field.html"><abbr title="src/PhpWord/Writer/RTF/Element/Field.php">Field.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">30</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write field element.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">public</span>
|
|
<span class="phpdocumentor-signature__name">write</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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_getStyles">
|
|
getStyles()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_getStyles" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">63</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Get font and paragraph styles.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">getStyles</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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeClosing">
|
|
writeClosing()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeClosing" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">138</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write closing.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeClosing</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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeDate">
|
|
writeDate()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writeDate" 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/Writer/RTF/Element/Field.php"><a href="files/src-phpword-writer-rtf-element-field.html"><abbr title="src/PhpWord/Writer/RTF/Element/Field.php">Field.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">69</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeDate</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Field.html"><abbr title="\PhpOffice\PhpWord\Element\Field">Field</abbr></a> </span><span class="phpdocumentor-signature__argument__name">$element</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
<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">$element</span>
|
|
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Element-Field.html"><abbr title="\PhpOffice\PhpWord\Element\Field">Field</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">mixed</span>
|
|
—
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
|
|
</article>
|
|
<article
|
|
class="phpdocumentor-element
|
|
-method
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeFontStyle">
|
|
writeFontStyle()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeFontStyle" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">152</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write font style.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeFontStyle</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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeNumpages">
|
|
writeNumpages()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writeNumpages" 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/Writer/RTF/Element/Field.php"><a href="files/src-phpword-writer-rtf-element-field.html"><abbr title="src/PhpWord/Writer/RTF/Element/Field.php">Field.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">64</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeNumpages</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeOpening">
|
|
writeOpening()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeOpening" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">105</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write opening.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeOpening</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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writePage">
|
|
writePage()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-Field.html#method_writePage" 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/Writer/RTF/Element/Field.php"><a href="files/src-phpword-writer-rtf-element-field.html"><abbr title="src/PhpWord/Writer/RTF/Element/Field.php">Field.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">59</span>
|
|
</aside>
|
|
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writePage</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
|
|
|
|
|
|
|
|
|
|
|
|
<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
|
|
-protected
|
|
"
|
|
>
|
|
<h4 class="phpdocumentor-element__name" id="method_writeText">
|
|
writeText()
|
|
<a href="classes/PhpOffice-PhpWord-Writer-RTF-Element-AbstractElement.html#method_writeText" 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/Writer/RTF/Element/AbstractElement.php"><a href="files/src-phpword-writer-rtf-element-abstractelement.html"><abbr title="src/PhpWord/Writer/RTF/Element/AbstractElement.php">AbstractElement.php</abbr></a></abbr>
|
|
:
|
|
<span class="phpdocumentor-element-found-in__line">124</span>
|
|
</aside>
|
|
|
|
<p class="phpdocumentor-summary">Write text.</p>
|
|
|
|
<code class="phpdocumentor-code phpdocumentor-signature ">
|
|
<span class="phpdocumentor-signature__visibility">protected</span>
|
|
<span class="phpdocumentor-signature__name">writeText</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>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
|
|
|
|
<section class="phpdocumentor-description"></section>
|
|
|
|
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
|
|
<dl class="phpdocumentor-argument-list">
|
|
<dt class="phpdocumentor-argument-list__entry">
|
|
<span class="phpdocumentor-signature__argument__name">$text</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">string</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-Writer-RTF-Element-Field.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
|
|
|
|
</main>
|
|
|
|
<script>
|
|
cssVars({});
|
|
</script>
|
|
</body>
|
|
</html>
|