Files
docx-js/api/interfaces/iparagraphstyleoptions.html

350 lines
22 KiB
HTML
Raw Normal View History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IParagraphStyleOptions | docx</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">docx</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="iparagraphstyleoptions.html">IParagraphStyleOptions</a>
</li>
</ul>
<h1>Interface IParagraphStyleOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ibaseparagraphstyleoptions.html" class="tsd-signature-type">IBaseParagraphStyleOptions</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">IParagraphStyleOptions</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-external">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#basedon" class="tsd-kind-icon">based<wbr>On</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="iparagraphstyleoptions.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#link" class="tsd-kind-icon">link</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="iparagraphstyleoptions.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#next" class="tsd-kind-icon">next</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#paragraph" class="tsd-kind-icon">paragraph</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#quickformat" class="tsd-kind-icon">quick<wbr>Format</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#semihidden" class="tsd-kind-icon">semi<wbr>Hidden</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#uipriority" class="tsd-kind-icon">ui<wbr>Priority</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="iparagraphstyleoptions.html#unhidewhenused" class="tsd-kind-icon">unhide<wbr>When<wbr>Used</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-external">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="basedon" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> based<wbr>On</h3>
<div class="tsd-signature tsd-kind-icon">based<wbr>On<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#basedon">basedOn</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L8">src/file/styles/style/paragraph-style.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="id" class="tsd-anchor"></a>
<h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L20">src/file/styles/style/paragraph-style.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="link" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> link</h3>
<div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#link">link</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L11">src/file/styles/style/paragraph-style.ts:11</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="name" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L21">src/file/styles/style/paragraph-style.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="next" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> next</h3>
<div class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#next">next</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L9">src/file/styles/style/paragraph-style.ts:9</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="paragraph" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> paragraph</h3>
<div class="tsd-signature tsd-kind-icon">paragraph<span class="tsd-signature-symbol">:</span> <a href="iparagraphstylepropertiesoptions.html" class="tsd-signature-type">IParagraphStylePropertiesOptions</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#paragraph">paragraph</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L15">src/file/styles/style/paragraph-style.ts:15</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="quickformat" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> quick<wbr>Format</h3>
<div class="tsd-signature tsd-kind-icon">quick<wbr>Format<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#quickformat">quickFormat</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L10">src/file/styles/style/paragraph-style.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="run" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> run</h3>
<div class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">:</span> <a href="irunstylepropertiesoptions.html" class="tsd-signature-type">IRunStylePropertiesOptions</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L16">src/file/styles/style/paragraph-style.ts:16</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="semihidden" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> semi<wbr>Hidden</h3>
<div class="tsd-signature tsd-kind-icon">semi<wbr>Hidden<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#semihidden">semiHidden</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L12">src/file/styles/style/paragraph-style.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="uipriority" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ui<wbr>Priority</h3>
<div class="tsd-signature tsd-kind-icon">ui<wbr>Priority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#uipriority">uiPriority</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L13">src/file/styles/style/paragraph-style.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a name="unhidewhenused" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> unhide<wbr>When<wbr>Used</h3>
<div class="tsd-signature tsd-kind-icon">unhide<wbr>When<wbr>Used<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="ibaseparagraphstyleoptions.html">IBaseParagraphStyleOptions</a>.<a href="ibaseparagraphstyleoptions.html#unhidewhenused">unhideWhenUsed</a></p>
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/styles/style/paragraph-style.ts#L14">src/file/styles/style/paragraph-style.ts:14</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-is-external">
<a href="iparagraphstyleoptions.html" class="tsd-kind-icon">IParagraph<wbr>Style<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#basedon" class="tsd-kind-icon">based<wbr>On</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="iparagraphstyleoptions.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#link" class="tsd-kind-icon">link</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="iparagraphstyleoptions.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#next" class="tsd-kind-icon">next</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#paragraph" class="tsd-kind-icon">paragraph</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#quickformat" class="tsd-kind-icon">quick<wbr>Format</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#semihidden" class="tsd-kind-icon">semi<wbr>Hidden</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#uipriority" class="tsd-kind-icon">ui<wbr>Priority</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
<a href="iparagraphstyleoptions.html#unhidewhenused" class="tsd-kind-icon">unhide<wbr>When<wbr>Used</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>