324 lines
20 KiB
HTML
324 lines
20 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>IPropertiesOptions | docx</title>
|
|
<meta name="description" content="Documentation for docx">
|
|
<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.json" 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="ipropertiesoptions.html">IPropertiesOptions</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface IPropertiesOptions</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>
|
|
<span class="target">IPropertiesOptions</span>
|
|
</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-external"><a href="ipropertiesoptions.html#background" class="tsd-kind-icon">background</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#compatabilitymodeversion" class="tsd-kind-icon">compatability<wbr>Mode<wbr>Version</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#creator" class="tsd-kind-icon">creator</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#description" class="tsd-kind-icon">description</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#externalstyles" class="tsd-kind-icon">external<wbr>Styles</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#features" class="tsd-kind-icon">features</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#footnotes" class="tsd-kind-icon">footnotes</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#keywords" class="tsd-kind-icon">keywords</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#lastmodifiedby" class="tsd-kind-icon">last<wbr>Modified<wbr>By</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#numbering" class="tsd-kind-icon">numbering</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#revision" class="tsd-kind-icon">revision</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#styles" class="tsd-kind-icon">styles</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#subject" class="tsd-kind-icon">subject</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="ipropertiesoptions.html#title" class="tsd-kind-icon">title</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-external">
|
|
<a name="background" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> background</h3>
|
|
<div class="tsd-signature tsd-kind-icon">background<span class="tsd-signature-symbol">:</span> <a href="idocumentbackgroundoptions.html" class="tsd-signature-type">IDocumentBackgroundOptions</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L22">src/file/core-properties/properties.ts:22</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="compatabilitymodeversion" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> compatability<wbr>Mode<wbr>Version</h3>
|
|
<div class="tsd-signature tsd-kind-icon">compatability<wbr>Mode<wbr>Version<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L26">src/file/core-properties/properties.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="creator" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> creator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">creator<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/694ac22/src/file/core-properties/properties.ts#L13">src/file/core-properties/properties.ts:13</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="description" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> description</h3>
|
|
<div class="tsd-signature tsd-kind-icon">description<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/694ac22/src/file/core-properties/properties.ts#L15">src/file/core-properties/properties.ts:15</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="externalstyles" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> external<wbr>Styles</h3>
|
|
<div class="tsd-signature tsd-kind-icon">external<wbr>Styles<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/694ac22/src/file/core-properties/properties.ts#L18">src/file/core-properties/properties.ts:18</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="features" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> features</h3>
|
|
<div class="tsd-signature tsd-kind-icon">features<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>trackRevisions<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><span class="tsd-signature-symbol"> }</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L23">src/file/core-properties/properties.ts:23</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="footnotes" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> footnotes</h3>
|
|
<div class="tsd-signature tsd-kind-icon">footnotes<span class="tsd-signature-symbol">:</span> <a href="../classes/paragraph.html" class="tsd-signature-type">Paragraph</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L21">src/file/core-properties/properties.ts:21</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="keywords" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> keywords</h3>
|
|
<div class="tsd-signature tsd-kind-icon">keywords<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/694ac22/src/file/core-properties/properties.ts#L14">src/file/core-properties/properties.ts:14</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="lastmodifiedby" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> last<wbr>Modified<wbr>By</h3>
|
|
<div class="tsd-signature tsd-kind-icon">last<wbr>Modified<wbr>By<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/694ac22/src/file/core-properties/properties.ts#L16">src/file/core-properties/properties.ts:16</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="numbering" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> numbering</h3>
|
|
<div class="tsd-signature tsd-kind-icon">numbering<span class="tsd-signature-symbol">:</span> <a href="inumberingoptions.html" class="tsd-signature-type">INumberingOptions</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L20">src/file/core-properties/properties.ts:20</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="revision" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> revision</h3>
|
|
<div class="tsd-signature tsd-kind-icon">revision<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/694ac22/src/file/core-properties/properties.ts#L17">src/file/core-properties/properties.ts:17</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="styles" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> styles</h3>
|
|
<div class="tsd-signature tsd-kind-icon">styles<span class="tsd-signature-symbol">:</span> <a href="istylesoptions.html" class="tsd-signature-type">IStylesOptions</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/694ac22/src/file/core-properties/properties.ts#L19">src/file/core-properties/properties.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="subject" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> subject</h3>
|
|
<div class="tsd-signature tsd-kind-icon">subject<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/694ac22/src/file/core-properties/properties.ts#L12">src/file/core-properties/properties.ts:12</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="title" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> title</h3>
|
|
<div class="tsd-signature tsd-kind-icon">title<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/694ac22/src/file/core-properties/properties.ts#L11">src/file/core-properties/properties.ts:11</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="ipropertiesoptions.html" class="tsd-kind-icon">IProperties<wbr>Options</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#background" class="tsd-kind-icon">background</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#compatabilitymodeversion" class="tsd-kind-icon">compatability<wbr>Mode<wbr>Version</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#creator" class="tsd-kind-icon">creator</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#description" class="tsd-kind-icon">description</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#externalstyles" class="tsd-kind-icon">external<wbr>Styles</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#features" class="tsd-kind-icon">features</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#footnotes" class="tsd-kind-icon">footnotes</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#keywords" class="tsd-kind-icon">keywords</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#lastmodifiedby" class="tsd-kind-icon">last<wbr>Modified<wbr>By</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#numbering" class="tsd-kind-icon">numbering</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#revision" class="tsd-kind-icon">revision</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#styles" class="tsd-kind-icon">styles</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#subject" class="tsd-kind-icon">subject</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="ipropertiesoptions.html#title" class="tsd-kind-icon">title</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">
|
|
</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>
|
|
</body>
|
|
</html> |