smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
0646849d06e8cb25cb3abdd9c84b9854d3f16999
docx-js/api/types/ITableOfContentsOptions.html

46 lines
18 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
<!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(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></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"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">docx</a></li><li><a href="ITableOfContentsOptions.html">ITableOfContentsOptions</a></li></ul><h1>Type Alias ITableOfContentsOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ITableOfContentsOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">captionLabel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">captionLabelIncludingNumbers</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">entriesFromBookmark</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">entryAndPageNumberSeparator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">headingStyleRange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">hideTabAndPageNumbersInWebView</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">hyperlink</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">pageNumbersEntryLevelsRange</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span cl
Deploying to gh-pages from @ dolanmiu/docx@71291dab8faefccfca37dc8ce92fd451d3be1068 🚀
2025-01-10 11:25:15 +00:00
<a href="https://www.ecma-international.org/publications/standards/Ecma-376.htm">https://www.ecma-international.org/publications/standards/Ecma-376.htm</a>
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
Part 1 - Page 1251</p>
<p>Short Guide:
Deploying to gh-pages from @ dolanmiu/docx@71291dab8faefccfca37dc8ce92fd451d3be1068 🚀
2025-01-10 11:25:15 +00:00
<a href="http://officeopenxml.com/WPtableOfContents.php">http://officeopenxml.com/WPtableOfContents.php</a></p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">captionLabel</span><a id="__typecaptionlabel" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\a option - Includes captioned items, but omits caption labels and numbers.
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">captionLabelIncludingNumbers</span><a id="__typecaptionlabelincludingnumbers" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\c option - Includes figures, tables, charts, and other items that are numbered
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">entriesFromBookmark</span><a id="__typeentriesfrombookmark" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\b option - Includes entries only from the portion of the document marked by
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
the bookmark named by text in this switch's field-argument.</p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">entryAndPageNumberSeparator</span><a id="__typeentryandpagenumberseparator" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\p option - Text in this switch's field-argument specifies a sequence of characters
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
that separate an entry and its page number. The default is a tab with leader dots.</p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">headingStyleRange</span><a id="__typeheadingstylerange" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\o option - Uses paragraphs formatted with all or the specified range of builtin
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">hideTabAndPageNumbersInWebView</span><a id="__typehidetabandpagenumbersinwebview" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><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></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">hyperlink</span><a id="__typehyperlink" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><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></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">pageNumbersEntryLevelsRange</span><a id="__typepagenumbersentrylevelsrange" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\n option - Without field-argument, omits page numbers from the table of contents.
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">preserveNewLineInEntries</span><a id="__typepreservenewlineinentries" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>\x Preserves newline characters within table entries.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">preserveTabInEntries</span><a id="__typepreservetabinentries" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>\w Preserves tab entries within table entries.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">seqFieldIdentifierForPrefix</span><a id="__typeseqfieldidentifierforprefix" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><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.
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
The prefix depends on the type of entry. text in this switch's field-argument shall match the
identifier in the SEQ field.</p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">sequenceAndPageNumbersSeparator</span><a id="__typesequenceandpagenumbersseparator" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\d option - When used with \s, the text in this switch's field-argument defines
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
the separator between sequence and page numbers. The default separator is a hyphen (-).</p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">stylesWithLevels</span><a id="__typestyleswithlevels" class="tsd-anchor"></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></h5><div class="tsd-comment tsd-typography"><p>\t field-argument Uses paragraphs formatted with styles other than the built-in heading styles.
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">tcFieldIdentifier</span><a id="__typetcfieldidentifier" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\f option - Includes only those TC fields whose identifier exactly matches the
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
text in this switch's field-argument (which is typically a letter).</p>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">tcFieldLevelRange</span><a id="__typetcfieldlevelrange" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>\l option - Includes TC fields that assign entries to one of the levels specified
Deploying to gh-pages from @ dolanmiu/docx@2381ba8a05e54e40ec78479ef09b7e06adab4dd0 🚀
2024-10-21 02:58:11 +00:00
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>
Deploying to gh-pages from @ dolanmiu/docx@df99f964692f8f6911a560e36f3af64e0e90a31d 🚀
2024-12-05 15:44:26 +00:00
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">useAppliedParagraphOutlineLevel</span><a id="__typeuseappliedparagraphoutlinelevel" class="tsd-anchor"></a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>\u Uses the applied paragraph outline level.</p>
Deploying to gh-pages from @ dolanmiu/docx@7405a19ae8a47a79616cf63c534fa48725fa8d11 🚀
2025-04-16 07:59:25 +00:00
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/7405a19ae8a47a79616cf63c534fa48725fa8d11/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></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>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></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>
Reference in New Issue Copy Permalink