Files
docx-js/api/interfaces/isectionpropertiesoptions.html
2021-06-09 00:05:50 +00:00

289 lines
18 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ISectionPropertiesOptions | docx</title>
<meta name="description" content="Documentation for docx">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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="isectionpropertiesoptions.html">ISectionPropertiesOptions</a>
</li>
</ul>
<h1>Interface ISectionPropertiesOptions</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>
<span class="target">ISectionPropertiesOptions</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="isectionpropertiesoptions.html#column" class="tsd-kind-icon">column</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#footerwrappergroup" class="tsd-kind-icon">footer<wbr>Wrapper<wbr>Group</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#grid" class="tsd-kind-icon">grid</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#headerwrappergroup" class="tsd-kind-icon">header<wbr>Wrapper<wbr>Group</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#linenumbers" class="tsd-kind-icon">line<wbr>Numbers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#page" class="tsd-kind-icon">page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#titlepage" class="tsd-kind-icon">title<wbr>Page</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#type" class="tsd-kind-icon">type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="isectionpropertiesoptions.html#verticalalign" class="tsd-kind-icon">vertical<wbr>Align</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 name="column" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> column</h3>
<div class="tsd-signature tsd-kind-icon">column<span class="tsd-signature-symbol">:</span> <a href="icolumnsattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IColumnsAttributes</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L39">src/file/document/body/section-properties/section-properties.ts:39</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="footerwrappergroup" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> footer<wbr>Wrapper<wbr>Group</h3>
<div class="tsd-signature tsd-kind-icon">footer<wbr>Wrapper<wbr>Group<span class="tsd-signature-symbol">:</span> <a href="iheaderfootergroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IHeaderFooterGroup</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/footerwrapper.html" class="tsd-signature-type" data-tsd-kind="Class">FooterWrapper</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L35">src/file/document/body/section-properties/section-properties.ts:35</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="grid" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> grid</h3>
<div class="tsd-signature tsd-kind-icon">grid<span class="tsd-signature-symbol">:</span> <a href="idocgridattributesproperties.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocGridAttributesProperties</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L33">src/file/document/body/section-properties/section-properties.ts:33</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="headerwrappergroup" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> header<wbr>Wrapper<wbr>Group</h3>
<div class="tsd-signature tsd-kind-icon">header<wbr>Wrapper<wbr>Group<span class="tsd-signature-symbol">:</span> <a href="iheaderfootergroup.html" class="tsd-signature-type" data-tsd-kind="Interface">IHeaderFooterGroup</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/headerwrapper.html" class="tsd-signature-type" data-tsd-kind="Class">HeaderWrapper</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L34">src/file/document/body/section-properties/section-properties.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="linenumbers" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> line<wbr>Numbers</h3>
<div class="tsd-signature tsd-kind-icon">line<wbr>Numbers<span class="tsd-signature-symbol">:</span> <a href="ilinenumberattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">ILineNumberAttributes</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L36">src/file/document/body/section-properties/section-properties.ts:36</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="page" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> page</h3>
<div class="tsd-signature tsd-kind-icon">page<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>borders<span class="tsd-signature-symbol">?: </span><a href="ipagebordersoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageBordersOptions</a><span class="tsd-signature-symbol">; </span>margin<span class="tsd-signature-symbol">?: </span><a href="ipagemarginattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageMarginAttributes</a><span class="tsd-signature-symbol">; </span>pageNumbers<span class="tsd-signature-symbol">?: </span><a href="ipagenumbertypeattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageNumberTypeAttributes</a><span class="tsd-signature-symbol">; </span>size<span class="tsd-signature-symbol">?: </span><a href="ipagesizeattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageSizeAttributes</a><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L27">src/file/document/body/section-properties/section-properties.ts:27</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> borders<span class="tsd-signature-symbol">?: </span><a href="ipagebordersoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageBordersOptions</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> margin<span class="tsd-signature-symbol">?: </span><a href="ipagemarginattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageMarginAttributes</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> page<wbr>Numbers<span class="tsd-signature-symbol">?: </span><a href="ipagenumbertypeattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageNumberTypeAttributes</a></h5>
</li>
<li class="tsd-parameter">
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> size<span class="tsd-signature-symbol">?: </span><a href="ipagesizeattributes.html" class="tsd-signature-type" data-tsd-kind="Interface">IPageSizeAttributes</a></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="titlepage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> title<wbr>Page</h3>
<div class="tsd-signature tsd-kind-icon">title<wbr>Page<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/db20efa/src/file/document/body/section-properties/section-properties.ts#L37">src/file/document/body/section-properties/section-properties.ts:37</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="type" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/sectiontype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">SectionType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L40">src/file/document/body/section-properties/section-properties.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="verticalalign" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> vertical<wbr>Align</h3>
<div class="tsd-signature tsd-kind-icon">vertical<wbr>Align<span class="tsd-signature-symbol">:</span> <a href="../enums/verticalalign.html" class="tsd-signature-type" data-tsd-kind="Enumeration">VerticalAlign</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/dolanmiu/docx/blob/db20efa/src/file/document/body/section-properties/section-properties.ts#L38">src/file/document/body/section-properties/section-properties.ts:38</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 class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface">
<a href="isectionpropertiesoptions.html" class="tsd-kind-icon">ISection<wbr>Properties<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#column" class="tsd-kind-icon">column</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#footerwrappergroup" class="tsd-kind-icon">footer<wbr>Wrapper<wbr>Group</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#grid" class="tsd-kind-icon">grid</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#headerwrappergroup" class="tsd-kind-icon">header<wbr>Wrapper<wbr>Group</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#linenumbers" class="tsd-kind-icon">line<wbr>Numbers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#page" class="tsd-kind-icon">page</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#titlepage" class="tsd-kind-icon">title<wbr>Page</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#type" class="tsd-kind-icon">type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="isectionpropertiesoptions.html#verticalalign" class="tsd-kind-icon">vertical<wbr>Align</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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>
</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/js/main.js"></script>
</body>
</html>