<!DOCTYPE html><htmlclass="default"lang="en"><head><metacharset="utf-8"/><metahttp-equiv="x-ua-compatible"content="IE=edge"/><title>PageBreakBefore | docx</title><metaname="description"content="Documentation for docx"/><metaname="viewport"content="width=device-width, initial-scale=1"/><linkrel="stylesheet"href="../assets/style.css"/><linkrel="stylesheet"href="../assets/highlight.css"/><scriptdefersrc="../assets/main.js"></script><scriptasyncsrc="../assets/icons.js"id="tsd-icons-script"></script><scriptasyncsrc="../assets/search.js"id="tsd-search-script"></script><scriptasyncsrc="../assets/navigation.js"id="tsd-nav-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><headerclass="tsd-page-toolbar"><divclass="tsd-toolbar-contents container"><divclass="table-cell"id="tsd-search"data-base=".."><divclass="field"><labelfor="tsd-search-field"class="tsd-widget tsd-toolbar-icon search no-caption"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-search"></use></svg></label><inputtype="text"id="tsd-search-field"aria-label="Search"/></div><divclass="field"><divid="tsd-toolbar-links"></div></div><ulclass="results"><liclass="state loading">Preparing search index...</li><liclass="state failure">The search index is not available</li></ul><ahref="../index.html"class="title">docx</a></div><divclass="table-cell"id="tsd-widgets"><ahref="#"class="tsd-widget tsd-toolbar-icon menu no-caption"data-toggle="menu"aria-label="Menu"><svgwidth="16"height="16"viewBox="0 0 16 16"fill="none"><usehref="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><divclass="container container-main"><divclass="col-content"><divclass="tsd-page-title"><ulclass="tsd-breadcrumb"><li><ahref="../modules.html">docx</a></li><li><ahref="PageBreakBefore.html">PageBreakBefore</a></li></ul><h1>Class PageBreakBefore</h1></div><sectionclass="tsd-panel tsd-comment"><divclass="tsd-comment tsd-typography"><p>Add page break before the paragraph if there is no one added before.</p>
</div></section></div></details></section></section><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Constructors"><h2><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><sectionclass="tsd-panel tsd-member"><aid="constructor"class="tsd-anchor"></a><h3class="tsd-anchor-link"><span>constructor</span><ahref="#constructor"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures"><liclass="tsd-signature tsd-anchor-link"><aid="constructor.new_PageBreakBefore"class="tsd-anchor"></a><spanclass="tsd-kind-constructor-signature">new <wbr/>Page<wbr/>Break<wbr/>Before</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="PageBreakBefore.html"class="tsd-signature-type tsd-kind-class">PageBreakBefore</a><ahref="#constructor.new_PageBreakBefore"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><h4class="tsd-returns-title">Returns <ahref="PageBreakBefore.html"class="tsd-signature-type tsd-kind-class">PageBreakBefore</a></h4><asideclass="tsd-sources"><p>Overrides <ahref="XmlComponent.html">XmlComponent</a>.<ahref="XmlComponent.html#constructor">constructor</a></p><ul><li>Defined in <ahref="https://github.com/dolanmiu/docx/blob/8bf5220e31b1cea9e0d6dfbec216df403b1b5585/src/file/paragraph/formatting/break.ts#L41">file/paragraph/formatting/break.ts:41</a></li></ul></aside></li></ul></section></section></details><detailsclass="tsd-panel-group tsd-member-group tsd-accordion"open><summaryclass="tsd-accordion-summary"data-key="section-Methods"><h2><svgwidth="20"height="20"viewBox="0 0 24 24"fill="none"><usehref="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><sectionclass="tsd-panel tsd-member tsd-is-inherited"><aid="addChildElement"class="tsd-anchor"></a><h3class="tsd-anchor-link"><spanclass="deprecated">add<wbr/>Child<wbr/>Element</span><ahref="#addChildElement"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ulclass="tsd-signatures tsd-is-inherited"><liclass="tsd-signature tsd-anchor-link"><aid="addChildElement.addChildElement-1"class="tsd-anchor"></a><spanclass="tsd-kind-call-signature">add<wbr/>Child<wbr/>Element</span><spanclass="tsd-signature-symbol">(</span><spanclass="tsd-kind-parameter">child</span><spanclass="tsd-signature-symbol">)</span><spanclass="tsd-signature-symbol">: </span><ahref="XmlComponent.html"class="tsd-signature-type tsd-kind-class">XmlComponent</a><ahref="#addChildElement.addChildElement-1"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></li><liclass="tsd-description"><divclass="tsd-parameters"><h4class="tsd-parameters-title">Parameters</h4><ulclass="tsd-parameter-list"><li><span><spanclass="tsd-kind-parameter">child</span>: <spanclass="tsd-signature-type">string</span><spanclass="tsd-signature-symbol"> | </span><ahref="XmlComponent.html"class="tsd-signature-type tsd-kind-class">XmlComponent</a></span></li></ul></div><h4class="tsd-returns-title">Returns <ahref="XmlComponent.html"class="tsd-signature-type tsd-kind-class">XmlComponent</a></h4><divclass="tsd-comment tsd-typography"><divclass="tsd-tag-Deprecated"><h4class="tsd-anchor-link"><aid="Deprecated"class="tsd-anchor"></a>Deprecated<ahref="#Deprecated"aria-label="Permalink"class="tsd-anchor-icon"><svgviewBox="0 0 24 24"><usehref="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Do not use this method. It is only used internally by the library. It will be removed in a future version.</p>
