1 line
15 KiB
HTML
1 line
15 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ICharacterStyleOptions | 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="ICharacterStyleOptions.html">ICharacterStyleOptions</a></li></ul><h1>Interface ICharacterStyleOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="IBaseCharacterStyleOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IBaseCharacterStyleOptions</a><ul class="tsd-hierarchy"><li><span class="target">ICharacterStyleOptions</span></li></ul></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 tsd-is-inherited"><a href="ICharacterStyleOptions.html#basedOn" class="tsd-kind-icon">based<wbr/>On</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ICharacterStyleOptions.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ICharacterStyleOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#quickFormat" class="tsd-kind-icon">quick<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#semiHidden" class="tsd-kind-icon">semi<wbr/>Hidden</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#uiPriority" class="tsd-kind-icon">ui<wbr/>Priority</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#unhideWhenUsed" class="tsd-kind-icon">unhide<wbr/>When<wbr/>Used</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 tsd-is-inherited"><a id="basedOn" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> based<wbr/>On</h3><div class="tsd-signature tsd-kind-icon">based<wbr/>On<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#basedOn">basedOn</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L44">src/file/styles/style/style.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3><div class="tsd-signature tsd-kind-icon">id<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/df6b1c0/src/file/styles/style/character-style.ts#L10">src/file/styles/style/character-style.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="link" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> link</h3><div class="tsd-signature tsd-kind-icon">link<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#link">link</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L46">src/file/styles/style/style.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="name" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> name</h3><div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/character-style.ts#L11">src/file/styles/style/character-style.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="next" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> next</h3><div class="tsd-signature tsd-kind-icon">next<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#next">next</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L45">src/file/styles/style/style.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="quickFormat" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> quick<wbr/>Format</h3><div class="tsd-signature tsd-kind-icon">quick<wbr/>Format<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#quickFormat">quickFormat</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L50">src/file/styles/style/style.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="run" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> run</h3><div class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">?:</span> <a href="IRunStylePropertiesOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IRunStylePropertiesOptions</a></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#run">run</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/character-style.ts#L6">src/file/styles/style/character-style.ts:6</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="semiHidden" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> semi<wbr/>Hidden</h3><div class="tsd-signature tsd-kind-icon">semi<wbr/>Hidden<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#semiHidden">semiHidden</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L48">src/file/styles/style/style.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="uiPriority" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> ui<wbr/>Priority</h3><div class="tsd-signature tsd-kind-icon">ui<wbr/>Priority<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#uiPriority">uiPriority</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L47">src/file/styles/style/style.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="unhideWhenUsed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> unhide<wbr/>When<wbr/>Used</h3><div class="tsd-signature tsd-kind-icon">unhide<wbr/>When<wbr/>Used<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="IBaseCharacterStyleOptions.html">IBaseCharacterStyleOptions</a>.<a href="IBaseCharacterStyleOptions.html#unhideWhenUsed">unhideWhenUsed</a></p><ul><li>Defined in <a href="https://github.com/dolanmiu/docx/blob/df6b1c0/src/file/styles/style/style.ts#L49">src/file/styles/style/style.ts:49</a></li></ul></aside></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="ICharacterStyleOptions.html" class="tsd-kind-icon">ICharacter<wbr/>Style<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#basedOn" class="tsd-kind-icon">based<wbr/>On</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ICharacterStyleOptions.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#link" class="tsd-kind-icon">link</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="ICharacterStyleOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#next" class="tsd-kind-icon">next</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#quickFormat" class="tsd-kind-icon">quick<wbr/>Format</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#semiHidden" class="tsd-kind-icon">semi<wbr/>Hidden</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#uiPriority" class="tsd-kind-icon">ui<wbr/>Priority</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ICharacterStyleOptions.html#unhideWhenUsed" class="tsd-kind-icon">unhide<wbr/>When<wbr/>Used</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 tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |