Aix/PHPWord
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
PHPWord/classes/PhpOffice-PhpWord-Writer-Word2007-Style-Image.html

882 lines
47 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<base href="../">
<link rel="icon" href="images/favicon.ico"/>
<link rel="stylesheet" href="css/normalize.css">
<link rel="stylesheet" href="css/base.css">
<link href="https://fonts.googleapis.com/css2?family=Source+Sans+Pro:wght@400;600;700&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/template.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
<script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
<script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/js/all.min.js" integrity="sha256-0vuk8LXoyrmCjp1f0O300qo1M75ZQyhH9X3J6d+scmk=" crossorigin="anonymous"></script>
<script src="js/search.js"></script>
<script defer src="js/searchIndex.js"></script>
</head>
<body id="top">
<header class="phpdocumentor-header phpdocumentor-section">
<h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
<input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
<label class="phpdocumentor-header__menu-icon" for="menu-button">
<i class="fas fa-bars"></i>
</label>
<section data-search-form class="phpdocumentor-search">
<label>
<span class="visually-hidden">Search for</span>
<svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
<circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
<line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
</svg>
<input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
</label>
</section>
<nav class="phpdocumentor-topnav">
<ul class="phpdocumentor-topnav__menu">
</ul>
</nav>
</header>
<main class="phpdocumentor">
<div class="phpdocumentor-section">
<input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
Menu
</label>
<aside class="phpdocumentor-column -four phpdocumentor-sidebar">
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
<h3 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/default.html"><abbr title="\">Global</abbr></a></h3>
<h4 class="phpdocumentor-sidebar__root-namespace"><a href="namespaces/phpoffice.html"><abbr title="\PhpOffice">PhpOffice</abbr></a></h4>
<ul class="phpdocumentor-list">
<li><a href="namespaces/phpoffice-phpword.html"><abbr title="\PhpOffice\PhpWord">PhpWord</abbr></a></li>
</ul>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
<h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
</section>
<section class="phpdocumentor-sidebar__category">
<h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
<h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
</section>
</aside>
<div class="phpdocumentor-column -eight phpdocumentor-content">
<ul class="phpdocumentor-breadcrumbs">
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice.html">PhpOffice</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword.html">PhpWord</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer.html">Writer</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-word2007.html">Word2007</a></li>
<li class="phpdocumentor-breadcrumb"><a href="namespaces/phpoffice-phpword-writer-word2007-style.html">Style</a></li>
</ul>
<article class="phpdocumentor-element -class">
<h2 class="phpdocumentor-content__title">
Image
<span class="phpdocumentor-element__extends">
extends <a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html"><abbr title="\PhpOffice\PhpWord\Writer\Word2007\Style\Frame">Frame</abbr></a>
</span>
</h2>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/PhpWord/Writer/Word2007/Style/Image.php"><a href="files/src-phpword-writer-word2007-style-image.html"><abbr title="src/PhpWord/Writer/Word2007/Style/Image.php">Image.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">25</span>
</aside>
<p class="phpdocumentor-summary">Image style writer.</p>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="#tags" class="headerlink"><i class="fas fa-link"></i></a>
</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">since</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link">0.10.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 -constant -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#constant_PHP_32BIT_INT_MAX">PHP_32BIT_INT_MAX</a>
<span>
&nbsp;= 2147483647 </span>
</dt>
<dd></dd>
<dt class="phpdocumentor-table-of-contents__entry -property -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#property_style">$style</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>|string </span>
</dt>
<dd>Style; set protected for a while.</dd>
<dt class="phpdocumentor-table-of-contents__entry -property -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#property_xmlWriter">$xmlWriter</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a> </span>
</dt>
<dd>XML writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method___construct">__construct()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Create new instance.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_write">write()</a>
<span>
&nbsp;: mixed </span>
</dt>
<dd>Write style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#method_writeAlignment">writeAlignment()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write alignment.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_assembleStyle">assembleStyle()</a>
<span>
&nbsp;: string </span>
</dt>
<dd>Assemble style array into style string.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_convertTwip">convertTwip()</a>
<span>
&nbsp;: float|int </span>
</dt>
<dd>Convert twip value.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_getStyle">getStyle()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>|string </span>
</dt>
<dd>Get Style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_getXmlWriter">getXmlWriter()</a>
<span>
&nbsp;: <a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a> </span>
</dt>
<dd>Get XML Writer.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_writeChildStyle">writeChildStyle()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write child style.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -protected">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_writeOnOf">writeOnOf()</a>
<span>
&nbsp;: null|string </span>
</dt>
<dd>Writes boolean as 0 or 1.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#method_getStyles">getStyles()</a>
<span>
&nbsp;: array&lt;string|int, mixed&gt; </span>
</dt>
<dd>Get style values in associative array.</dd>
<dt class="phpdocumentor-table-of-contents__entry -method -private">
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#method_writeWrap">writeWrap()</a>
<span>
&nbsp;: void </span>
</dt>
<dd>Write wrap.</dd>
</dl>
<section class="phpdocumentor-constants">
<h3 class="phpdocumentor-elements__header" id="constants">
Constants
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Image.html#constants" class="headerlink"><i class="fas fa-link"></i></a>
</h3>
<article class="phpdocumentor-element -constant -public ">
<h4 class="phpdocumentor-element__name" id="constant_PHP_32BIT_INT_MAX">
PHP_32BIT_INT_MAX
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#constant_PHP_32BIT_INT_MAX" 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/Word2007/Style/Frame.php"><a href="files/src-phpword-writer-word2007-style-frame.html"><abbr title="src/PhpWord/Writer/Word2007/Style/Frame.php">Frame.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">31</span>
</aside>
<code class="phpdocumentor-signature phpdocumentor-code ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__type">mixed</span>
<span class="phpdocumentor-signature__name">PHP_32BIT_INT_MAX</span>
= <span class="phpdocumentor-signature__default-value">2147483647</span>
</code>
</article>
</section>
<section class="phpdocumentor-properties">
<h3 class="phpdocumentor-elements__header" id="properties">
Properties
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Image.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_style">
$style
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#property_style" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">42</span>
</aside>
<p class="phpdocumentor-summary">Style; set protected for a while.</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-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>|string</span>
<span class="phpdocumentor-signature__name">$style</span>
</code>
<section class="phpdocumentor-description"></section>
</article>
<article
class="
phpdocumentor-element
-property
-private
"
>
<h4 class="phpdocumentor-element__name" id="property_xmlWriter">
$xmlWriter
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#property_xmlWriter" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>
</aside>
<p class="phpdocumentor-summary">XML writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
<span class="phpdocumentor-signature__name">$xmlWriter</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-Word2007-Style-Image.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-Word2007-Style-AbstractStyle.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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">54</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-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </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>|string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$style</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">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">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$style</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>|string</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">mixed</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-public
-abstract "
>
<h4 class="phpdocumentor-element__name" id="method_write">
write()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">47</span>
</aside>
<p class="phpdocumentor-summary">Write style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__abstract">abstract</span> <span class="phpdocumentor-signature__name">write</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">mixed</span></code>
<section class="phpdocumentor-description"></section>
<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_writeAlignment">
writeAlignment()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#method_writeAlignment" 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/Word2007/Style/Frame.php"><a href="files/src-phpword-writer-word2007-style-frame.html"><abbr title="src/PhpWord/Writer/Word2007/Style/Frame.php">Frame.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">86</span>
</aside>
<p class="phpdocumentor-summary">Write alignment.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__name">writeAlignment</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">void</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_assembleStyle">
assembleStyle()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_assembleStyle" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">146</span>
</aside>
<p class="phpdocumentor-summary">Assemble style array into style string.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">assembleStyle</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">$styles</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">[]</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$styles</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
= <span class="phpdocumentor-signature__argument__default-value">[]</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_convertTwip">
convertTwip()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_convertTwip" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">88</span>
</aside>
<p class="phpdocumentor-summary">Convert twip value.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">convertTwip</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type">float|int&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">int&nbsp;</span><span class="phpdocumentor-signature__argument__name">$default</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">float|int</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">float|int</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</span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>(int|float)</p>
</section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">float|int</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getStyle">
getStyle()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_getStyle" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">75</span>
</aside>
<p class="phpdocumentor-summary">Get Style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getStyle</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>|string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Style-AbstractStyle.html"><abbr title="\PhpOffice\PhpWord\Style\AbstractStyle">AbstractStyle</abbr></a>|string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_getXmlWriter">
getXmlWriter()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_getXmlWriter" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">65</span>
</aside>
<p class="phpdocumentor-summary">Get XML Writer.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">getXmlWriter</span><span>(</span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_writeChildStyle">
writeChildStyle()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_writeChildStyle" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">112</span>
</aside>
<p class="phpdocumentor-summary">Write child style.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">writeChildStyle</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</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">$name</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><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">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$name</span>
: <span class="phpdocumentor-signature__argument__return-type">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">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">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-protected
"
>
<h4 class="phpdocumentor-element__name" id="method_writeOnOf">
writeOnOf()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-AbstractStyle.html#method_writeOnOf" 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/Word2007/Style/AbstractStyle.php"><a href="files/src-phpword-writer-word2007-style-abstractstyle.html"><abbr title="src/PhpWord/Writer/Word2007/Style/AbstractStyle.php">AbstractStyle.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">130</span>
</aside>
<p class="phpdocumentor-summary">Writes boolean as 0 or 1.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">protected</span>
<span class="phpdocumentor-signature__name">writeOnOf</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">null</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">null|string</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$value</span>
: <span class="phpdocumentor-signature__argument__return-type">bool</span>
= <span class="phpdocumentor-signature__argument__default-value">null</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"></section>
</dd>
</dl>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">null|string</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_getStyles">
getStyles()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.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/Word2007/Style/Frame.php"><a href="files/src-phpword-writer-word2007-style-frame.html"><abbr title="src/PhpWord/Writer/Word2007/Style/Frame.php">Frame.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">155</span>
</aside>
<p class="phpdocumentor-summary">Get style values in associative array.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">getStyles</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Style-Frame.html"><abbr title="\PhpOffice\PhpWord\Style\Frame">Frame</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$style</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;&nbsp;</span><span class="phpdocumentor-signature__argument__name">$properties</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$suffix</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&#039;&#039;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">array&lt;string|int, mixed&gt;</span></code>
<section class="phpdocumentor-description"></section>
<h5 class="phpdocumentor-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"><a href="classes/PhpOffice-PhpWord-Style-Frame.html"><abbr title="\PhpOffice\PhpWord\Style\Frame">Frame</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$properties</span>
: <span class="phpdocumentor-signature__argument__return-type">array&lt;string|int, mixed&gt;</span>
</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">$suffix</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&#039;&#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">array&lt;string|int, mixed&gt;</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
<article
class="phpdocumentor-element
-method
-private
"
>
<h4 class="phpdocumentor-element__name" id="method_writeWrap">
writeWrap()
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Frame.html#method_writeWrap" 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/Word2007/Style/Frame.php"><a href="files/src-phpword-writer-word2007-style-frame.html"><abbr title="src/PhpWord/Writer/Word2007/Style/Frame.php">Frame.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">113</span>
</aside>
<p class="phpdocumentor-summary">Write wrap.</p>
<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">private</span>
<span class="phpdocumentor-signature__name">writeWrap</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$xmlWriter</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Style-Frame.html"><abbr title="\PhpOffice\PhpWord\Style\Frame">Frame</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$style</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">$wrap</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">$xmlWriter</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Shared-XMLWriter.html"><abbr title="\PhpOffice\PhpWord\Shared\XMLWriter">XMLWriter</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$style</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/PhpOffice-PhpWord-Style-Frame.html"><abbr title="\PhpOffice\PhpWord\Style\Frame">Frame</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$wrap</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">void</span>
&mdash;
<section class="phpdocumentor-description"></section>
</article>
</section>
</article>
<section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
<section class="phpdocumentor-search-results__dialog">
<header class="phpdocumentor-search-results__header">
<h2 class="phpdocumentor-search-results__title">Search results</h2>
<button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
</header>
<section class="phpdocumentor-search-results__body">
<ul class="phpdocumentor-search-results__entries"></ul>
</section>
</section>
</section>
</div>
</div>
<a href="classes/PhpOffice-PhpWord-Writer-Word2007-Style-Image.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
</main>
<script>
cssVars({});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink