2018-02-21 21:37:01 +00:00
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
<title>File | 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>
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html">File</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Class File</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">File</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">
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-index-section tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Constructors</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="file.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-index-section tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Accessors</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#appproperties" class="tsd-kind-icon">App<wbr>Properties</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#contenttypes" class="tsd-kind-icon">Content<wbr>Types</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#coreproperties" class="tsd-kind-icon">Core<wbr>Properties</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#document" class="tsd-kind-icon">Document</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#documentrelationships" class="tsd-kind-icon">Document<wbr>Relationships</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#filerelationships" class="tsd-kind-icon">File<wbr>Relationships</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#footnotes" class="tsd-kind-icon">Foot<wbr>Notes</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#footers" class="tsd-kind-icon">Footers</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#headers" class="tsd-kind-icon">Headers</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#media" class="tsd-kind-icon">Media</a></li>
|
|
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#numbering" class="tsd-kind-icon">Numbering</a></li>
|
2018-09-25 22:36:37 +00:00
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#settings" class="tsd-kind-icon">Settings</a></li>
|
2019-10-10 20:31:32 +00:00
|
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-external"><a href="file.html#styles" class="tsd-kind-icon">Styles</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-index-section tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Methods</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#addsection" class="tsd-kind-icon">add<wbr>Section</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createbookmark" class="tsd-kind-icon">create<wbr>Bookmark</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createhyperlink" class="tsd-kind-icon">create<wbr>Hyperlink</a></li>
|
|
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#createinternalhyperlink" class="tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link</a></li>
|
2018-09-25 22:36:37 +00:00
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="file.html#verifyupdatefields" class="tsd-kind-icon">verify<wbr>Update<wbr>Fields</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<h2>Constructors</h2>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
|
|
|
<h3>constructor</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
2019-08-06 22:40:09 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>File<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ipropertiesoptions.html" class="tsd-signature-type">IPropertiesOptions</a>, fileProperties<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ifileproperties.html" class="tsd-signature-type">IFileProperties</a>, sections<span class="tsd-signature-symbol">?: </span><a href="../interfaces/isectionoptions.html" class="tsd-signature-type">ISectionOptions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="file.html" class="tsd-signature-type">File</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L63">file/file.ts:63</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-12-04 01:45:42 +00:00
|
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> options: <a href="../interfaces/ipropertiesoptions.html" class="tsd-signature-type">IPropertiesOptions</a><span class="tsd-signature-symbol"> = {creator: "Un-named",revision: "1",lastModifiedBy: "Un-named",footnotes: [],}</span></h5>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2019-08-06 22:40:09 +00:00
|
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> fileProperties: <a href="../interfaces/ifileproperties.html" class="tsd-signature-type">IFileProperties</a><span class="tsd-signature-symbol"> = {}</span></h5>
|
2018-10-22 23:50:33 +00:00
|
|
|
</li>
|
|
|
|
|
<li>
|
2019-08-06 22:40:09 +00:00
|
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> sections: <a href="../interfaces/isectionoptions.html" class="tsd-signature-type">ISectionOptions</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="file.html" class="tsd-signature-type">File</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<h2>Accessors</h2>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="appproperties" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>App<wbr>Properties</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> AppProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="appproperties.html" class="tsd-signature-type">AppProperties</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L328">file/file.ts:328</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="appproperties.html" class="tsd-signature-type">AppProperties</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="contenttypes" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Content<wbr>Types</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> ContentTypes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L324">file/file.ts:324</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="contenttypes.html" class="tsd-signature-type">ContentTypes</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="coreproperties" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Core<wbr>Properties</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> CoreProperties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L296">file/file.ts:296</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="coreproperties.html" class="tsd-signature-type">CoreProperties</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="document" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Document</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Document<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="document.html" class="tsd-signature-type">Document</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L288">file/file.ts:288</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="document.html" class="tsd-signature-type">Document</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:37:01 +00:00
|
|
|
<a name="documentrelationships" class="tsd-anchor"></a>
|
|
|
|
|
<h3>Document<wbr>Relationships</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> DocumentRelationships<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="relationships.html" class="tsd-signature-type">Relationships</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L308">file/file.ts:308</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="filerelationships" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>File<wbr>Relationships</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> FileRelationships<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="relationships.html" class="tsd-signature-type">Relationships</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L312">file/file.ts:312</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="relationships.html" class="tsd-signature-type">Relationships</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-06-30 22:56:07 +00:00
|
|
|
<a name="footnotes" class="tsd-anchor"></a>
|
|
|
|
|
<h3>Foot<wbr>Notes</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> FootNotes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footnotes.html" class="tsd-signature-type">FootNotes</a></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L332">file/file.ts:332</a></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="footnotes.html" class="tsd-signature-type">FootNotes</a></h4>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-06-30 22:56:07 +00:00
|
|
|
<a name="footers" class="tsd-anchor"></a>
|
|
|
|
|
<h3>Footers</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Footers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a><span class="tsd-signature-symbol">[]</span></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L320">file/file.ts:320</a></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="footerwrapper.html" class="tsd-signature-type">FooterWrapper</a><span class="tsd-signature-symbol">[]</span></h4>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-06-30 22:56:07 +00:00
|
|
|
<a name="headers" class="tsd-anchor"></a>
|
|
|
|
|
<h3>Headers</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Headers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a><span class="tsd-signature-symbol">[]</span></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L316">file/file.ts:316</a></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="headerwrapper.html" class="tsd-signature-type">HeaderWrapper</a><span class="tsd-signature-symbol">[]</span></h4>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="media" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Media</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Media<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="media.html" class="tsd-signature-type">Media</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L304">file/file.ts:304</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="media.html" class="tsd-signature-type">Media</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="numbering" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Numbering</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Numbering<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="numbering.html" class="tsd-signature-type">Numbering</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L300">file/file.ts:300</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="numbering.html" class="tsd-signature-type">Numbering</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-09-25 22:36:37 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<a name="settings" class="tsd-anchor"></a>
|
|
|
|
|
<h3>Settings</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Settings<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="settings.html" class="tsd-signature-type">Settings</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L336">file/file.ts:336</a></li>
|
2018-09-25 22:36:37 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <a href="settings.html" class="tsd-signature-type">Settings</a></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2019-10-10 20:31:32 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-02-21 21:48:39 +00:00
|
|
|
<a name="styles" class="tsd-anchor"></a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<h3>Styles</h3>
|
2019-10-10 20:31:32 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> Styles<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="styles.html" class="tsd-signature-type">Styles</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L292">file/file.ts:292</a></li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="styles.html" class="tsd-signature-type">Styles</a></h4>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-06-30 22:56:07 +00:00
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
2018-06-30 22:56:07 +00:00
|
|
|
<h2>Methods</h2>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-06-30 22:56:07 +00:00
|
|
|
<a name="addsection" class="tsd-anchor"></a>
|
|
|
|
|
<h3>add<wbr>Section</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2019-08-06 22:40:09 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Section<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L172">file/file.ts:172</a></li>
|
2018-06-30 22:56:07 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
2019-08-06 22:40:09 +00:00
|
|
|
<h5>__namedParameters: <span class="tsd-signature-type">object</span></h5>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
</ul>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-07-24 21:44:17 +00:00
|
|
|
<a name="createbookmark" class="tsd-anchor"></a>
|
|
|
|
|
<h3>create<wbr>Bookmark</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2019-08-06 22:40:09 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Bookmark<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, text<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="bookmark.html" class="tsd-signature-type">Bookmark</a></li>
|
2018-07-24 21:44:17 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L168">file/file.ts:168</a></li>
|
2018-07-24 21:44:17 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
2019-08-06 22:40:09 +00:00
|
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> text: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = name</span></h5>
|
2018-07-24 21:44:17 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="bookmark.html" class="tsd-signature-type">Bookmark</a></h4>
|
2018-07-24 21:44:17 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-05-08 00:18:25 +00:00
|
|
|
<a name="createhyperlink" class="tsd-anchor"></a>
|
|
|
|
|
<h3>create<wbr>Hyperlink</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Hyperlink<span class="tsd-signature-symbol">(</span>link<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, text<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></li>
|
2018-05-08 00:18:25 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L148">file/file.ts:148</a></li>
|
2018-05-08 00:18:25 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>link: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></h4>
|
2018-05-08 00:18:25 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-08-08 22:25:00 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-07-24 21:44:17 +00:00
|
|
|
<a name="createinternalhyperlink" class="tsd-anchor"></a>
|
|
|
|
|
<h3>create<wbr>Internal<wbr>Hyper<wbr>Link</h3>
|
2018-08-08 22:25:00 +00:00
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link<span class="tsd-signature-symbol">(</span>anchor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, text<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></li>
|
2018-07-24 21:44:17 +00:00
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L160">file/file.ts:160</a></li>
|
2018-07-24 21:44:17 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5>anchor: <span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> text: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
2018-08-09 10:56:44 +00:00
|
|
|
<h4 class="tsd-returns-title">Returns <a href="hyperlink.html" class="tsd-signature-type">Hyperlink</a></h4>
|
2018-07-24 21:44:17 +00:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-09-25 22:36:37 +00:00
|
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<a name="verifyupdatefields" class="tsd-anchor"></a>
|
|
|
|
|
<h3>verify<wbr>Update<wbr>Fields</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">verify<wbr>Update<wbr>Fields<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="tsd-descriptions">
|
|
|
|
|
<li class="tsd-description">
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
2019-12-04 01:45:42 +00:00
|
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/9683e89/src/file/file.ts#L201">file/file.ts:201</a></li>
|
2018-09-25 22:36:37 +00:00
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</section>
|
2018-02-21 21:37:01 +00:00
|
|
|
</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">
|
2018-08-09 10:56:44 +00:00
|
|
|
<li class="current tsd-kind-class tsd-is-external">
|
|
|
|
|
<a href="file.html" class="tsd-kind-icon">File</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
<ul>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#constructor" class="tsd-kind-icon">constructor</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#appproperties" class="tsd-kind-icon">App<wbr>Properties</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#contenttypes" class="tsd-kind-icon">Content<wbr>Types</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#coreproperties" class="tsd-kind-icon">Core<wbr>Properties</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#document" class="tsd-kind-icon">Document</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#documentrelationships" class="tsd-kind-icon">Document<wbr>Relationships</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#filerelationships" class="tsd-kind-icon">File<wbr>Relationships</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#footnotes" class="tsd-kind-icon">Foot<wbr>Notes</a>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#footers" class="tsd-kind-icon">Footers</a>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#headers" class="tsd-kind-icon">Headers</a>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#media" class="tsd-kind-icon">Media</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#numbering" class="tsd-kind-icon">Numbering</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-09-25 22:36:37 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<a href="file.html#settings" class="tsd-kind-icon">Settings</a>
|
|
|
|
|
</li>
|
2019-10-10 20:31:32 +00:00
|
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#styles" class="tsd-kind-icon">Styles</a>
|
2018-02-21 21:37:01 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#addsection" class="tsd-kind-icon">add<wbr>Section</a>
|
2018-06-30 22:56:07 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#createbookmark" class="tsd-kind-icon">create<wbr>Bookmark</a>
|
2018-07-24 21:44:17 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#createhyperlink" class="tsd-kind-icon">create<wbr>Hyperlink</a>
|
2018-05-08 00:18:25 +00:00
|
|
|
</li>
|
2018-08-08 22:25:00 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
2018-08-09 10:56:44 +00:00
|
|
|
<a href="file.html#createinternalhyperlink" class="tsd-kind-icon">create<wbr>Internal<wbr>Hyper<wbr>Link</a>
|
2018-07-24 21:44:17 +00:00
|
|
|
</li>
|
2018-09-25 22:36:37 +00:00
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
|
|
|
<a href="file.html#verifyupdatefields" class="tsd-kind-icon">verify<wbr>Update<wbr>Fields</a>
|
|
|
|
|
</li>
|
2018-02-21 21:37:01 +00:00
|
|
|
</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>
|
|
|
|
|
</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="http://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>
|
