Files
docx-js/api/types/IRunOptions.html
2025-04-16 22:52:20 +00:00

2 lines
9.7 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IRunOptions | 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">IRunOptions</a></li></ul><h1>Type Alias IRunOptions</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">IRunOptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">break</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-keyword">readonly</span> (<br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Begin</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">FieldInstruction</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Separate</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">End</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/PageNumber.html" class="tsd-signature-type tsd-kind-variable">PageNumber</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-keyword">keyof</span> <span class="tsd-signature-keyword">typeof</span> <a href="../variables/PageNumber.html" class="tsd-signature-type tsd-kind-variable">PageNumber</a><span class="tsd-signature-symbol">]</span><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/FootnoteReferenceRun.html" class="tsd-signature-type tsd-kind-class">FootnoteReferenceRun</a><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Break</span><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/AnnotationReference.html" class="tsd-signature-type tsd-kind-class">AnnotationReference</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/CarriageReturn.html" class="tsd-signature-type tsd-kind-class">CarriageReturn</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/ContinuationSeparator.html" class="tsd-signature-type tsd-kind-class">ContinuationSeparator</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/DayLong.html" class="tsd-signature-type tsd-kind-class">DayLong</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/DayShort.html" class="tsd-signature-type tsd-kind-class">DayShort</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/EndnoteReference.html" class="tsd-signature-type tsd-kind-class">EndnoteReference</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/FootnoteReferenceElement.html" class="tsd-signature-type tsd-kind-class">FootnoteReferenceElement</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/LastRenderedPageBreak.html" class="tsd-signature-type tsd-kind-class">LastRenderedPageBreak</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/MonthLong.html" class="tsd-signature-type tsd-kind-class">MonthLong</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/MonthShort.html" class="tsd-signature-type tsd-kind-class">MonthShort</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/NoBreakHyphen.html" class="tsd-signature-type tsd-kind-class">NoBreakHyphen</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/PageNumberElement.html" class="tsd-signature-type tsd-kind-class">PageNumberElement</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/Separator.html" class="tsd-signature-type tsd-kind-class">Separator</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/SoftHyphen.html" class="tsd-signature-type tsd-kind-class">SoftHyphen</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/Tab.html" class="tsd-signature-type tsd-kind-class">Tab</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/YearLong.html" class="tsd-signature-type tsd-kind-class">YearLong</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/YearShort.html" class="tsd-signature-type tsd-kind-class">YearShort</a><br/>        <span class="tsd-signature-symbol">|</span> <a href="../classes/PositionalTab.html" class="tsd-signature-type tsd-kind-class">PositionalTab</a><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/>    )<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&amp;</span> <a href="IRunPropertiesOptions.html" class="tsd-signature-type tsd-kind-type-alias">IRunPropertiesOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/1403ac664be10a37403ba9c1b22fa5294a749e2d/src/file/paragraph/run/run.ts#L32">file/paragraph/run/run.ts:32</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"><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></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>