520 lines
34 KiB
HTML
520 lines
34 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>ITableOfContentsOptions | 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="itableofcontentsoptions.html">ITableOfContentsOptions</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Interface ITableOfContentsOptions</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Options according to this docs:
|
|
<a href="https://www.ecma-international.org/publications/standards/Ecma-376.htm">https://www.ecma-international.org/publications/standards/Ecma-376.htm</a>
|
|
Part 1 - Page 1251</p>
|
|
</div>
|
|
<p>Short Guide:
|
|
<a href="http://officeopenxml.com/WPtableOfContents.php">http://officeopenxml.com/WPtableOfContents.php</a></p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">ITableOfContentsOptions</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="itableofcontentsoptions.html#captionlabel" class="tsd-kind-icon">caption<wbr>Label</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#captionlabelincludingnumbers" class="tsd-kind-icon">caption<wbr>Label<wbr>Including<wbr>Numbers</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#entriesfrombookmark" class="tsd-kind-icon">entries<wbr>From<wbr>Bookmark</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#entryandpagenumberseparator" class="tsd-kind-icon">entry<wbr>And<wbr>Page<wbr>Number<wbr>Separator</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#headingstylerange" class="tsd-kind-icon">heading<wbr>Style<wbr>Range</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#hidetabandpagenumbersinwebview" class="tsd-kind-icon">hide<wbr>Tab<wbr>And<wbr>Page<wbr>Numbers<wbr>InWeb<wbr>View</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#hyperlink" class="tsd-kind-icon">hyperlink</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#pagenumbersentrylevelsrange" class="tsd-kind-icon">page<wbr>Numbers<wbr>Entry<wbr>Levels<wbr>Range</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#preservenewlineinentries" class="tsd-kind-icon">preserve<wbr>New<wbr>Line<wbr>InEntries</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#preservetabinentries" class="tsd-kind-icon">preserve<wbr>Tab<wbr>InEntries</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#seqfieldidentifierforprefix" class="tsd-kind-icon">seq<wbr>Field<wbr>Identifier<wbr>For<wbr>Prefix</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#sequenceandpagenumbersseparator" class="tsd-kind-icon">sequence<wbr>And<wbr>Page<wbr>Numbers<wbr>Separator</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#styleswithlevels" class="tsd-kind-icon">styles<wbr>With<wbr>Levels</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#tcfieldidentifier" class="tsd-kind-icon">tc<wbr>Field<wbr>Identifier</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#tcfieldlevelrange" class="tsd-kind-icon">tc<wbr>Field<wbr>Level<wbr>Range</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="itableofcontentsoptions.html#useappliedparagraphoutlinelevel" class="tsd-kind-icon">use<wbr>Applied<wbr>Paragraph<wbr>Outline<wbr>Level</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="captionlabel" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> caption<wbr>Label</h3>
|
|
<div class="tsd-signature tsd-kind-icon">caption<wbr>Label<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/table-of-contents/table-of-contents-properties.ts#L25">src/file/table-of-contents/table-of-contents-properties.ts:25</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\a option - Includes captioned items, but omits caption labels and numbers.
|
|
The identifier designated by text in this switch's field-argument corresponds to the caption label.
|
|
Use captionLabelIncludingNumbers (\c) to build a table of captions with labels and numbers.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="captionlabelincludingnumbers" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> caption<wbr>Label<wbr>Including<wbr>Numbers</h3>
|
|
<div class="tsd-signature tsd-kind-icon">caption<wbr>Label<wbr>Including<wbr>Numbers<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/table-of-contents/table-of-contents-properties.ts#L39">src/file/table-of-contents/table-of-contents-properties.ts:39</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\c option - Includes figures, tables, charts, and other items that are numbered
|
|
by a SEQ field (§17.16.5.56). The sequence identifier designated by text in this switch's
|
|
field-argument, which corresponds to the caption label, shall match the identifier in the
|
|
corresponding SEQ field.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="entriesfrombookmark" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> entries<wbr>From<wbr>Bookmark</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entries<wbr>From<wbr>Bookmark<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/table-of-contents/table-of-contents-properties.ts#L31">src/file/table-of-contents/table-of-contents-properties.ts:31</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\b option - Includes entries only from the portion of the document marked by
|
|
the bookmark named by text in this switch's field-argument.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="entryandpagenumberseparator" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> entry<wbr>And<wbr>Page<wbr>Number<wbr>Separator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">entry<wbr>And<wbr>Page<wbr>Number<wbr>Separator<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/table-of-contents/table-of-contents-properties.ts#L86">src/file/table-of-contents/table-of-contents-properties.ts:86</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\p option - Text in this switch's field-argument specifies a sequence of characters
|
|
that separate an entry and its page number. The default is a tab with leader dots.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="headingstylerange" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> heading<wbr>Style<wbr>Range</h3>
|
|
<div class="tsd-signature tsd-kind-icon">heading<wbr>Style<wbr>Range<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/table-of-contents/table-of-contents-properties.ts#L80">src/file/table-of-contents/table-of-contents-properties.ts:80</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\o option - Uses paragraphs formatted with all or the specified range of builtin
|
|
heading styles. Headings in a style range are specified by text in this switch's
|
|
field-argument using the notation specified as for \l, where each integer corresponds
|
|
to the style with a style ID of HeadingX (e.g. 1 corresponds to Heading1).
|
|
If no heading range is specified, all heading levels used in the document are listed.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="hidetabandpagenumbersinwebview" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hide<wbr>Tab<wbr>And<wbr>Page<wbr>Numbers<wbr>InWeb<wbr>View</h3>
|
|
<div class="tsd-signature tsd-kind-icon">hide<wbr>Tab<wbr>And<wbr>Page<wbr>Numbers<wbr>InWeb<wbr>View<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L121">src/file/table-of-contents/table-of-contents-properties.ts:121</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\z Hides tab leader and page numbers in web page view (§17.18.102).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="hyperlink" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hyperlink</h3>
|
|
<div class="tsd-signature tsd-kind-icon">hyperlink<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L56">src/file/table-of-contents/table-of-contents-properties.ts:56</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\h option - Makes the table of contents entries hyperlinks.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="pagenumbersentrylevelsrange" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr>Numbers<wbr>Entry<wbr>Levels<wbr>Range</h3>
|
|
<div class="tsd-signature tsd-kind-icon">page<wbr>Numbers<wbr>Entry<wbr>Levels<wbr>Range<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/table-of-contents/table-of-contents-properties.ts#L71">src/file/table-of-contents/table-of-contents-properties.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\n option - Without field-argument, omits page numbers from the table of contents.
|
|
Page numbers are omitted from all levels unless a range of entry levels is specified by
|
|
text in this switch's field-argument. A range is specified as for \l.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="preservenewlineinentries" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> preserve<wbr>New<wbr>Line<wbr>InEntries</h3>
|
|
<div class="tsd-signature tsd-kind-icon">preserve<wbr>New<wbr>Line<wbr>InEntries<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L116">src/file/table-of-contents/table-of-contents-properties.ts:116</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\x Preserves newline characters within table entries.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="preservetabinentries" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> preserve<wbr>Tab<wbr>InEntries</h3>
|
|
<div class="tsd-signature tsd-kind-icon">preserve<wbr>Tab<wbr>InEntries<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L111">src/file/table-of-contents/table-of-contents-properties.ts:111</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\w Preserves tab entries within table entries.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="seqfieldidentifierforprefix" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> seq<wbr>Field<wbr>Identifier<wbr>For<wbr>Prefix</h3>
|
|
<div class="tsd-signature tsd-kind-icon">seq<wbr>Field<wbr>Identifier<wbr>For<wbr>Prefix<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/table-of-contents/table-of-contents-properties.ts#L93">src/file/table-of-contents/table-of-contents-properties.ts:93</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\s option - For entries numbered with a SEQ field (§17.16.5.56), adds a prefix to the page number.
|
|
The prefix depends on the type of entry. text in this switch's field-argument shall match the
|
|
identifier in the SEQ field.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="sequenceandpagenumbersseparator" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> sequence<wbr>And<wbr>Page<wbr>Numbers<wbr>Separator</h3>
|
|
<div class="tsd-signature tsd-kind-icon">sequence<wbr>And<wbr>Page<wbr>Numbers<wbr>Separator<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/table-of-contents/table-of-contents-properties.ts#L45">src/file/table-of-contents/table-of-contents-properties.ts:45</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\d option - When used with \s, the text in this switch's field-argument defines
|
|
the separator between sequence and page numbers. The default separator is a hyphen (-).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="styleswithlevels" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> styles<wbr>With<wbr>Levels</h3>
|
|
<div class="tsd-signature tsd-kind-icon">styles<wbr>With<wbr>Levels<span class="tsd-signature-symbol">:</span> <a href="../classes/stylelevel.html" class="tsd-signature-type">StyleLevel</a><span class="tsd-signature-symbol">[]</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L101">src/file/table-of-contents/table-of-contents-properties.ts:101</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
|
|
Text in this switch's field-argument specifies those styles as a set of comma-separated doublets,
|
|
with each doublet being a comma-separated set of style name and table of content level.
|
|
\t can be combined with \o.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="tcfieldidentifier" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tc<wbr>Field<wbr>Identifier</h3>
|
|
<div class="tsd-signature tsd-kind-icon">tc<wbr>Field<wbr>Identifier<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/table-of-contents/table-of-contents-properties.ts#L51">src/file/table-of-contents/table-of-contents-properties.ts:51</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\f option - Includes only those TC fields whose identifier exactly matches the
|
|
text in this switch's field-argument (which is typically a letter).</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="tcfieldlevelrange" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tc<wbr>Field<wbr>Level<wbr>Range</h3>
|
|
<div class="tsd-signature tsd-kind-icon">tc<wbr>Field<wbr>Level<wbr>Range<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/table-of-contents/table-of-contents-properties.ts#L64">src/file/table-of-contents/table-of-contents-properties.ts:64</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\l option - Includes TC fields that assign entries to one of the levels specified
|
|
by text in this switch's field-argument as a range having the form startLevel-endLevel,
|
|
where startLevel and endLevel are integers, and startLevel has a value equal-to or less-than endLevel.
|
|
TC fields that assign entries to lower levels are skipped.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a name="useappliedparagraphoutlinelevel" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> use<wbr>Applied<wbr>Paragraph<wbr>Outline<wbr>Level</h3>
|
|
<div class="tsd-signature tsd-kind-icon">use<wbr>Applied<wbr>Paragraph<wbr>Outline<wbr>Level<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">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/6667595/src/file/table-of-contents/table-of-contents-properties.ts#L106">src/file/table-of-contents/table-of-contents-properties.ts:106</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>\u Uses the applied paragraph outline level.</p>
|
|
</div>
|
|
</div>
|
|
</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="itableofcontentsoptions.html" class="tsd-kind-icon">ITable<wbr>OfContents<wbr>Options</a>
|
|
<ul>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#captionlabel" class="tsd-kind-icon">caption<wbr>Label</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#captionlabelincludingnumbers" class="tsd-kind-icon">caption<wbr>Label<wbr>Including<wbr>Numbers</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#entriesfrombookmark" class="tsd-kind-icon">entries<wbr>From<wbr>Bookmark</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#entryandpagenumberseparator" class="tsd-kind-icon">entry<wbr>And<wbr>Page<wbr>Number<wbr>Separator</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#headingstylerange" class="tsd-kind-icon">heading<wbr>Style<wbr>Range</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#hidetabandpagenumbersinwebview" class="tsd-kind-icon">hide<wbr>Tab<wbr>And<wbr>Page<wbr>Numbers<wbr>InWeb<wbr>View</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#hyperlink" class="tsd-kind-icon">hyperlink</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#pagenumbersentrylevelsrange" class="tsd-kind-icon">page<wbr>Numbers<wbr>Entry<wbr>Levels<wbr>Range</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#preservenewlineinentries" class="tsd-kind-icon">preserve<wbr>New<wbr>Line<wbr>InEntries</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#preservetabinentries" class="tsd-kind-icon">preserve<wbr>Tab<wbr>InEntries</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#seqfieldidentifierforprefix" class="tsd-kind-icon">seq<wbr>Field<wbr>Identifier<wbr>For<wbr>Prefix</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#sequenceandpagenumbersseparator" class="tsd-kind-icon">sequence<wbr>And<wbr>Page<wbr>Numbers<wbr>Separator</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#styleswithlevels" class="tsd-kind-icon">styles<wbr>With<wbr>Levels</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#tcfieldidentifier" class="tsd-kind-icon">tc<wbr>Field<wbr>Identifier</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#tcfieldlevelrange" class="tsd-kind-icon">tc<wbr>Field<wbr>Level<wbr>Range</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
|
|
<a href="itableofcontentsoptions.html#useappliedparagraphoutlinelevel" class="tsd-kind-icon">use<wbr>Applied<wbr>Paragraph<wbr>Outline<wbr>Level</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> |