2021-11-08 16:17:40 +00:00
|
|
|
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ITableOfContentsOptions | docx</title><meta name="description" content="Documentation for docx"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../modules.html">docx</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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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><div><p>Short Guide:
|
|
|
|
|
<a href="http://officeopenxml.com/WPtableOfContents.php">http://officeopenxml.com/WPtableOfContents.php</a></p>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></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 "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#captionLabel" class="tsd-kind-icon">caption<wbr/>Label</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><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"><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"><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"><a href="ITableOfContentsOptions.html#hideTabAndPageNumbersInWebView" class="tsd-kind-icon">hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#hyperlink" class="tsd-kind-icon">hyperlink</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><a href="ITableOfContentsOptions.html#preserveNewLineInEntries" class="tsd-kind-icon">preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#preserveTabInEntries" class="tsd-kind-icon">preserve<wbr/>Tab<wbr/>In<wbr/>Entries</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><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"><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"><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"><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"><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 "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="captionLabel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/src/file/table-of-contents/table-
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="captionLabelIncludingNumbers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="entriesFromBookmark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="entryAndPageNumberSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="headingStyleRange" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="hideTabAndPageNumbersInWebView" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</h3><div class="tsd-signature tsd-kind-icon">hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>\z Hides tab leader and page numbers in web page view (§17.18.102).</p>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="hyperlink" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> hyperlink</h3><div class="tsd-signature tsd-kind-icon">hyperlink<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>\h option - Makes the table of contents entries hyperlinks.</p>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageNumbersEntryLevelsRange" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="preserveNewLineInEntries" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</h3><div class="tsd-signature tsd-kind-icon">preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>\x Preserves newline characters within table entries.</p>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="preserveTabInEntries" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> preserve<wbr/>Tab<wbr/>In<wbr/>Entries</h3><div class="tsd-signature tsd-kind-icon">preserve<wbr/>Tab<wbr/>In<wbr/>Entries<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<p>\w Preserves tab entries within table entries.</p>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="seqFieldIdentifierForPrefix" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sequenceAndPageNumbersSeparator" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="stylesWithLevels" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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" data-tsd-kind="Class">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/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tcFieldIdentifier" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tcFieldLevelRange" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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>
|
2021-11-15 11:18:52 +00:00
|
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useAppliedParagraphOutlineLevel" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</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">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/0a9b98e/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">
|
2021-09-30 02:17:43 +00:00
|
|
|
<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=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ITableOfContentsOptions.html" class="tsd-kind-icon">ITable<wbr/>Of<wbr/>Contents<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#captionLabel" class="tsd-kind-icon">caption<wbr/>Label</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><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"><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"><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"><a href="ITableOfContentsOptions.html#hideTabAndPageNumbersInWebView" class="tsd-kind-icon">hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#hyperlink" class="tsd-kind-icon">hyperlink</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><a href="ITableOfContentsOptions.html#preserveNewLineInEntries" class="tsd-kind-icon">preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ITableOfContentsOptions.html#preserveTabInEntries" class="tsd-kind-icon">preserve<wbr/>Tab<wbr/>In<wbr/>Entries</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><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"><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"><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"><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"><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"><a href="ITableOfContentsOptions.html#useAppliedParagraphOutlineLevel" class="tsd-kind-icon">use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level</a></li></ul></li></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-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></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 t
|
