PHPWord/classes/PhpOffice-PhpWord-Style-Paper.html

1864 lines
91 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-style.html">Style</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Paper
<span class="phpdocumentor-element__extends">
extends <a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>
</span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">94</span>
</aside>
<p class="phpdocumentor-summary">Paper size from ISO/IEC 29500-1:2012 pg. 1656-1657</p>
<section class="phpdocumentor-description"><p>1 = Letter paper (8.5 in. by 11 in.)
2 = Letter small paper (8.5 in. by 11 in.)
3 = Tabloid paper (11 in. by 17 in.)
4 = Ledger paper (17 in. by 11 in.)
5 = Legal paper (8.5 in. by 14 in.)
6 = Statement paper (5.5 in. by 8.5 in.)
7 = Executive paper (7.25 in. by 10.5 in.)
8 = A3 paper (297 mm by 420 mm)
9 = A4 paper (210 mm by 297 mm)
10 = A4 small paper (210 mm by 297 mm)
11 = A5 paper (148 mm by 210 mm)
12 = B4 paper (250 mm by 353 mm)
13 = B5 paper (176 mm by 250 mm)
14 = Folio paper (8.5 in. by 13 in.)
15 = Quarto paper (215 mm by 275 mm)
16 = Standard paper (10 in. by 14 in.)
17 = Standard paper (11 in. by 17 in.)
18 = Note paper (8.5 in. by 11 in.)
19 = #9 envelope (3.875 in. by 8.875 in.)
20 = #10 envelope (4.125 in. by 9.5 in.)
21 = #11 envelope (4.5 in. by 10.375 in.)
22 = #12 envelope (4.75 in. by 11 in.)
23 = #14 envelope (5 in. by 11.5 in.)
24 = C paper (17 in. by 22 in.)
25 = D paper (22 in. by 34 in.)
26 = E paper (34 in. by 44 in.)
27 = DL envelope (110 mm by 220 mm)
28 = C5 envelope (162 mm by 229 mm)
29 = C3 envelope (324 mm by 458 mm)
30 = C4 envelope (229 mm by 324 mm)
31 = C6 envelope (114 mm by 162 mm)
32 = C65 envelope (114 mm by 229 mm)
33 = B4 envelope (250 mm by 353 mm)
34 = B5 envelope (176 mm by 250 mm)
35 = B6 envelope (176 mm by 125 mm)
36 = Italy envelope (110 mm by 230 mm)
37 = Monarch envelope (3.875 in. by 7.5 in.).
38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
39 = US standard fanfold (14.875 in. by 11 in.)
40 = German standard fanfold (8.5 in. by 12 in.)
41 = German legal fanfold (8.5 in. by 13 in.)
42 = ISO B4 (250 mm by 353 mm)
43 = Japanese double postcard (200 mm by 148 mm)
44 = Standard paper (9 in. by 11 in.)
45 = Standard paper (10 in. by 11 in.)
46 = Standard paper (15 in. by 11 in.)
47 = Invite envelope (220 mm by 220 mm)
50 = Letter extra paper (9.275 in. by 12 in.)
51 = Legal extra paper (9.275 in. by 15 in.)
52 = Tabloid extra paper (11.69 in. by 18 in.)
53 = A4 extra paper (236 mm by 322 mm)
54 = Letter transverse paper (8.275 in. by 11 in.)
55 = A4 transverse paper (210 mm by 297 mm)
56 = Letter extra transverse paper (9.275 in. by 12 in.)
57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)
58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)
59 = Letter plus paper (8.5 in. by 12.69 in.)
60 = A4 plus paper (210 mm by 330 mm)
61 = A5 transverse paper (148 mm by 210 mm)
62 = JIS B5 transverse paper (182 mm by 257 mm)
63 = A3 extra paper (322 mm by 445 mm)
64 = A5 extra paper (174 mm by 235 mm)
65 = ISO B5 extra paper (201 mm by 276 mm)
66 = A2 paper (420 mm by 594 mm)
67 = A3 transverse paper (297 mm by 420 mm)
68 = A3 extra transverse paper (322 mm by 445 mm)</p>
</section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h3 id="toc">
Table of Contents
<a href="#toc" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_aliases">$aliases</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Aliases</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_index">$index</a>
<span>
&nbsp;: int|null </span>
</dt>
<dd>Index number in Style collection for named style</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_styleName">$styleName</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Style name</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_height">$height</a>
<span>
&nbsp;: float </span>
</dt>
<dd>Height</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_isAuto">$isAuto</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Is this an automatic style? (Used primarily in OpenDocument driver)</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_size">$size</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Paper size</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_sizes">$sizes</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Paper sizes</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_width">$width</a>
<span>
&nbsp;: float </span>
</dt>
<dd>Width</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Create a new instance</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getChildStyleValue">getChildStyleValue()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getHeight">getHeight()</a>
<span>
&nbsp;: float </span>
</dt>
<dd>Get height</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getIndex">getIndex()</a>
<span>
&nbsp;: int|null </span>
</dt>
<dd>Get index number</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getSize">getSize()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get size</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getStyleName">getStyleName()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Get style name</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getWidth">getWidth()</a>
<span>
&nbsp;: float </span>
</dt>
<dd>Get width</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_isAuto">isAuto()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Get is automatic style flag</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setArrayStyle">setArrayStyle()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set style using associative array</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setAuto">setAuto()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set is automatic style flag</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setIndex">setIndex()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set index number</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_setSize">setSize()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set size</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleByArray">setStyleByArray()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set style by using associative array</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleName">setStyleName()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set style name</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleValue">setStyleValue()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set style value template method</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setBoolVal">setBoolVal()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Set bool value</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setEnumVal">setEnumVal()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set enum value</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setFloatVal">setFloatVal()</a>
<span>
&nbsp;: float|null </span>
</dt>
<dd>Set float value: Convert string that contains only numeric into float</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setIntVal">setIntVal()</a>
<span>
&nbsp;: int|null </span>
</dt>
<dd>Set integer value: Convert string that contains only numeric into integer</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setNonEmptyVal">setNonEmptyVal()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Set default for null and empty value</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setNumericVal">setNumericVal()</a>
<span>
&nbsp;: int|float|null </span>
</dt>
<dd>Set numeric value</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setObjectVal">setObjectVal()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Set object value</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setPairedVal">setPairedVal()</a>
<span>
&nbsp;: self </span>
</dt>
<dd>Set $property value and set $pairProperty = false when $value = true</dd>
</dl>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Style-Paper.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_aliases">
$aliases
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_aliases" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">50</span>
</aside>
<p class="phpdocumentor-summary">Aliases</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$aliases</span>
= <span class="phpdocumentor-signature__default-value">array()</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_index">
$index
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_index" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">43</span>
</aside>
<p class="phpdocumentor-summary">Index number in Style collection for named style</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__type">int|null</span>
<span class="phpdocumentor-signature__name">$index</span>
</code>
<section class="phpdocumentor-description"><p>This number starts from one and defined in Style::setStyleValues()</p>
</section>
</article>
<article
class="
phpdocumentor-element
-property
-protected
"
>
<h4 class="phpdocumentor-element__name" id="property_styleName">
$styleName
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_styleName" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">34</span>
</aside>
<p class="phpdocumentor-summary">Style name</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">$styleName</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_height">
$height
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_height" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Height</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">float</span>
<span class="phpdocumentor-signature__name">$height</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_isAuto">
$isAuto
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#property_isAuto" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">58</span>
</aside>
<p class="phpdocumentor-summary">Is this an automatic style? (Used primarily in OpenDocument driver)</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">bool</span>
<span class="phpdocumentor-signature__name">$isAuto</span>
= <span class="phpdocumentor-signature__default-value">false</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_size">
$size
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_size" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">116</span>
</aside>
<p class="phpdocumentor-summary">Paper size</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">$size</span>
= <span class="phpdocumentor-signature__default-value">&#039;A4&#039;</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_sizes">
$sizes
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_sizes" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">101</span>
</aside>
<p class="phpdocumentor-summary">Paper sizes</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">array&lt;string|int, mixed&gt;</span>
<span class="phpdocumentor-signature__name">$sizes</span>
= <span class="phpdocumentor-signature__default-value">array(&#039;A3&#039; =&gt; array(297, 420, &#039;mm&#039;), &#039;A4&#039; =&gt; array(210, 297, &#039;mm&#039;), &#039;A5&#039; =&gt; array(148, 210, &#039;mm&#039;), &#039;B5&#039; =&gt; array(176, 250, &#039;mm&#039;), &#039;Folio&#039; =&gt; array(8.5, 13, &#039;in&#039;), &#039;Legal&#039; =&gt; array(8.5, 14, &#039;in&#039;), &#039;Letter&#039; =&gt; array(8.5, 11, &#039;in&#039;))</span></code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_width">
$width
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#property_width" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">123</span>
</aside>
<p class="phpdocumentor-summary">Width</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type">float</span>
<span class="phpdocumentor-signature__name">$width</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-Style-Paper.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-Style-Paper.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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Create a 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>[</span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;A4&#039;</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">$size</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;A4&#039;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getChildStyleValue">
getChildStyleValue()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getChildStyleValue" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">137</span>
</aside>
<p class="phpdocumentor-summary">Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getChildStyleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$substyleObject</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$substyleProperty</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">$substyleObject</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a></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">$substyleProperty</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-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.12.0</span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getHeight">
getHeight()
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getHeight" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">190</span>
</aside>
<p class="phpdocumentor-summary">Get height</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getHeight</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">float</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getIndex">
getIndex()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getIndex" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<p class="phpdocumentor-summary">Get index number</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getIndex</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">int|null</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getSize">
getSize()
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getSize" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">147</span>
</aside>
<p class="phpdocumentor-summary">Get size</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getSize</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getStyleName">
getStyleName()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_getStyleName" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Get style name</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getStyleName</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_getWidth">
getWidth()
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_getWidth" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">180</span>
</aside>
<p class="phpdocumentor-summary">Get width</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">getWidth</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">float</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_isAuto">
isAuto()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_isAuto" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">111</span>
</aside>
<p class="phpdocumentor-summary">Get is automatic style flag</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">isAuto</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-deprecated "
>
<h4 class="phpdocumentor-element__name" id="method_setArrayStyle">
setArrayStyle()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setArrayStyle" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">350</span>
</aside>
<p class="phpdocumentor-summary">Set style using associative array</p>
<code class="phpdocumentor-code phpdocumentor-signature -deprecated">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setArrayStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$style</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">array()</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">deprecated</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.11.0</span>
<section class="phpdocumentor-description"></section>
</dd>
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">codeCoverageIgnore</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setAuto">
setAuto()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setAuto" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">122</span>
</aside>
<p class="phpdocumentor-summary">Set is automatic style flag</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setAuto</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">true</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">true</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setIndex">
setIndex()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setIndex" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">99</span>
</aside>
<p class="phpdocumentor-summary">Set index number</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setIndex</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setSize">
setSize()
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#method_setSize" 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/Style/Paper.php"><a href="files/src-phpword-style-paper.html"><abbr title="src/PhpWord/Style/Paper.php">Paper.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">158</span>
</aside>
<p class="phpdocumentor-summary">Set size</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setSize</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$size</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$size</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setStyleByArray">
setStyleByArray()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleByArray" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">179</span>
</aside>
<p class="phpdocumentor-summary">Set style by using associative array</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setStyleByArray</span><span>(</span><span class="phpdocumentor-signature__argument"><span>[</span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$values</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$values</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">array()</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setStyleName">
setStyleName()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleName" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">76</span>
</aside>
<p class="phpdocumentor-summary">Set style name</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setStyleName</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
"
>
<h4 class="phpdocumentor-element__name" id="method_setStyleValue">
setStyleValue()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setStyleValue" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">160</span>
</aside>
<p class="phpdocumentor-summary">Set style value template method</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">setStyleValue</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$key</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"><p>Some child classes have their own specific overrides.
Backward compability check for versions &lt; 0.10.0 which use underscore
prefix for their private properties.
Check if the set method is exists. Throws an exception?</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">$key</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">$value</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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setBoolVal">
setBoolVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setBoolVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">211</span>
</aside>
<p class="phpdocumentor-summary">Set bool value</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setBoolVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</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">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</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">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">bool</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setEnumVal">
setEnumVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">286</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">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$enum</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">array()</span><span> ]</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$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">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">$value</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"></section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$enum</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">array()</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">mixed</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">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><abbr title="\InvalidArgumentException">InvalidArgumentException</abbr></span>
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setFloatVal">
setFloatVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setFloatVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">264</span>
</aside>
<p class="phpdocumentor-summary">Set float value: Convert string that contains only numeric into float</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setFloatVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">float|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float|null</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">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">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">float|null</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">float|null</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setIntVal">
setIntVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setIntVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">243</span>
</aside>
<p class="phpdocumentor-summary">Set integer value: Convert string that contains only numeric into integer</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setIntVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|null</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|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">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">int|null</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">int|null</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setNonEmptyVal">
setNonEmptyVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setNonEmptyVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">195</span>
</aside>
<p class="phpdocumentor-summary">Set default for null and empty value</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setNonEmptyVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</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">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(was: mixed)</p>
</section>
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(was: mixed)</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"><p>(was: mixed)</p>
</section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setNumericVal">
setNumericVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setNumericVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">227</span>
</aside>
<p class="phpdocumentor-summary">Set numeric value</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setNumericVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">int|float|null&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">int|float|null</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">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">$default</span>
: <span class="phpdocumentor-signature__argument__return-type">int|float|null</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">int|float|null</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setObjectVal">
setObjectVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setObjectVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">305</span>
</aside>
<p class="phpdocumentor-summary">Set object value</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setObjectVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$styleName</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">mixed&nbsp;</span><span class="phpdocumentor-signature__argument__reference-operator">&amp;</span><span class="phpdocumentor-signature__argument__name">$style</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">$value</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">$styleName</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">$style</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">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_setPairedVal">
setPairedVal()
<a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html#method_setPairedVal" 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/Style/AbstractStyle.php"><a href="files/src-phpword-style-abstractstyle.html"><abbr title="src/PhpWord/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">329</span>
</aside>
<p class="phpdocumentor-summary">Set $property value and set $pairProperty = false when $value = true</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">setPairedVal</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__reference-operator">&amp;</span><span class="phpdocumentor-signature__argument__name">$property</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__reference-operator">&amp;</span><span class="phpdocumentor-signature__argument__name">$pairProperty</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">bool&nbsp;</span><span class="phpdocumentor-signature__argument__name">$value</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">self</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$property</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</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">$pairProperty</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</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">$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">self</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Style-Paper.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>