62 lines
36 KiB
HTML
62 lines
36 KiB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base="../"><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 defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">docx</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">ITableOfContentsOptions</a></li></ul><h1>Type Alias ITableOfContentsOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><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>
|
||
<p>Short Guide:
|
||
<a href="http://officeopenxml.com/WPtableOfContents.php">http://officeopenxml.com/WPtableOfContents.php</a></p>
|
||
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">ITableOfContentsOptions</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#captionlabel">captionLabel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#captionlabelincludingnumbers">captionLabelIncludingNumbers</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entriesfrombookmark">entriesFromBookmark</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entryandpagenumberseparator">entryAndPageNumberSeparator</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#headingstylerange">headingStyleRange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidetabandpagenumbersinwebview">hideTabAndPageNumbersInWebView</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hyperlink">hyperlink</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pagenumbersentrylevelsrange">pageNumbersEntryLevelsRange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#preservenewlineinentries">preserveNewLineInEntries</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#preservetabinentries">preserveTabInEntries</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#seqfieldidentifierforprefix">seqFieldIdentifierForPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#sequenceandpagenumbersseparator">sequenceAndPageNumbersSeparator</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#styleswithlevels">stylesWithLevels</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <a href="../classes/StyleLevel.html" class="tsd-signature-type tsd-kind-class">StyleLevel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tcfieldidentifier">tcFieldIdentifier</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tcfieldlevelrange">tcFieldLevelRange</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#useappliedparagraphoutlinelevel">useAppliedParagraphOutlineLevel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L19">file/table-of-contents/table-of-contents-properties.ts:19</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#captionlabel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption<wbr/>Label?</span></a>
|
||
<a href="#captionlabelincludingnumbers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption<wbr/>Label<wbr/>Including<wbr/>Numbers?</span></a>
|
||
<a href="#entriesfrombookmark" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entries<wbr/>From<wbr/>Bookmark?</span></a>
|
||
<a href="#entryandpagenumberseparator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator?</span></a>
|
||
<a href="#headingstylerange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>heading<wbr/>Style<wbr/>Range?</span></a>
|
||
<a href="#hidetabandpagenumbersinwebview" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View?</span></a>
|
||
<a href="#hyperlink" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hyperlink?</span></a>
|
||
<a href="#pagenumbersentrylevelsrange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range?</span></a>
|
||
<a href="#preservenewlineinentries" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries?</span></a>
|
||
<a href="#preservetabinentries" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preserve<wbr/>Tab<wbr/>In<wbr/>Entries?</span></a>
|
||
<a href="#seqfieldidentifierforprefix" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix?</span></a>
|
||
<a href="#sequenceandpagenumbersseparator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator?</span></a>
|
||
<a href="#styleswithlevels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles<wbr/>With<wbr/>Levels?</span></a>
|
||
<a href="#tcfieldidentifier" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tc<wbr/>Field<wbr/>Identifier?</span></a>
|
||
<a href="#tcfieldlevelrange" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tc<wbr/>Field<wbr/>Level<wbr/>Range?</span></a>
|
||
<a href="#useappliedparagraphoutlinelevel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level?</span></a>
|
||
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="captionlabel"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>caption<wbr/>Label</span><a href="#captionlabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">captionLabel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L25">file/table-of-contents/table-of-contents-properties.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="captionlabelincludingnumbers"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>caption<wbr/>Label<wbr/>Including<wbr/>Numbers</span><a href="#captionlabelincludingnumbers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">captionLabelIncludingNumbers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L39">file/table-of-contents/table-of-contents-properties.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="entriesfrombookmark"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entries<wbr/>From<wbr/>Bookmark</span><a href="#entriesfrombookmark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entriesFromBookmark</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L31">file/table-of-contents/table-of-contents-properties.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="entryandpagenumberseparator"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator</span><a href="#entryandpagenumberseparator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">entryAndPageNumberSeparator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L86">file/table-of-contents/table-of-contents-properties.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headingstylerange"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>heading<wbr/>Style<wbr/>Range</span><a href="#headingstylerange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headingStyleRange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L80">file/table-of-contents/table-of-contents-properties.ts:80</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hidetabandpagenumbersinwebview"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</span><a href="#hidetabandpagenumbersinwebview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideTabAndPageNumbersInWebView</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>\z Hides tab leader and page numbers in web page view (§17.18.102).</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L121">file/table-of-contents/table-of-contents-properties.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hyperlink"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>hyperlink</span><a href="#hyperlink" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hyperlink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>\h option - Makes the table of contents entries hyperlinks.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L56">file/table-of-contents/table-of-contents-properties.ts:56</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pagenumbersentrylevelsrange"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range</span><a href="#pagenumbersentrylevelsrange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pageNumbersEntryLevelsRange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L71">file/table-of-contents/table-of-contents-properties.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="preservenewlineinentries"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</span><a href="#preservenewlineinentries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">preserveNewLineInEntries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>\x Preserves newline characters within table entries.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L116">file/table-of-contents/table-of-contents-properties.ts:116</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="preservetabinentries"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>preserve<wbr/>Tab<wbr/>In<wbr/>Entries</span><a href="#preservetabinentries" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">preserveTabInEntries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>\w Preserves tab entries within table entries.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L111">file/table-of-contents/table-of-contents-properties.ts:111</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="seqfieldidentifierforprefix"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix</span><a href="#seqfieldidentifierforprefix" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">seqFieldIdentifierForPrefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L93">file/table-of-contents/table-of-contents-properties.ts:93</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sequenceandpagenumbersseparator"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator</span><a href="#sequenceandpagenumbersseparator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sequenceAndPageNumbersSeparator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L45">file/table-of-contents/table-of-contents-properties.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="styleswithlevels"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>styles<wbr/>With<wbr/>Levels</span><a href="#styleswithlevels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stylesWithLevels</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> <a href="../classes/StyleLevel.html" class="tsd-signature-type tsd-kind-class">StyleLevel</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L101">file/table-of-contents/table-of-contents-properties.ts:101</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tcfieldidentifier"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tc<wbr/>Field<wbr/>Identifier</span><a href="#tcfieldidentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tcFieldIdentifier</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L51">file/table-of-contents/table-of-contents-properties.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tcfieldlevelrange"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tc<wbr/>Field<wbr/>Level<wbr/>Range</span><a href="#tcfieldlevelrange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tcFieldLevelRange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L64">file/table-of-contents/table-of-contents-properties.ts:64</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="useappliedparagraphoutlinelevel"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level</span><a href="#useappliedparagraphoutlinelevel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">useAppliedParagraphOutlineLevel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>\u Uses the applied paragraph outline level.</p>
|
||
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/b1bb95df79dc358076e91ab68a85af7b549f54f1/src/file/table-of-contents/table-of-contents-properties.ts#L106">file/table-of-contents/table-of-contents-properties.ts:106</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#captionlabel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption<wbr/>Label</span></a><a href="#captionlabelincludingnumbers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>caption<wbr/>Label<wbr/>Including<wbr/>Numbers</span></a><a href="#entriesfrombookmark"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entries<wbr/>From<wbr/>Bookmark</span></a><a href="#entryandpagenumberseparator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entry<wbr/>And<wbr/>Page<wbr/>Number<wbr/>Separator</span></a><a href="#headingstylerange"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>heading<wbr/>Style<wbr/>Range</span></a><a href="#hidetabandpagenumbersinwebview"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Tab<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>In<wbr/>Web<wbr/>View</span></a><a href="#hyperlink"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hyperlink</span></a><a href="#pagenumbersentrylevelsrange"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Numbers<wbr/>Entry<wbr/>Levels<wbr/>Range</span></a><a href="#preservenewlineinentries"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preserve<wbr/>New<wbr/>Line<wbr/>In<wbr/>Entries</span></a><a href="#preservetabinentries"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preserve<wbr/>Tab<wbr/>In<wbr/>Entries</span></a><a href="#seqfieldidentifierforprefix"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>seq<wbr/>Field<wbr/>Identifier<wbr/>For<wbr/>Prefix</span></a><a href="#sequenceandpagenumbersseparator"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sequence<wbr/>And<wbr/>Page<wbr/>Numbers<wbr/>Separator</span></a><a href="#styleswithlevels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>styles<wbr/>With<wbr/>Levels</span></a><a href="#tcfieldidentifier"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tc<wbr/>Field<wbr/>Identifier</span></a><a href="#tcfieldlevelrange"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tc<wbr/>Field<wbr/>Level<wbr/>Range</span></a><a href="#useappliedparagraphoutlinelevel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Applied<wbr/>Paragraph<wbr/>Outline<wbr/>Level</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">docx</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|