# GrapeCity.Documents.Text.TextLayout.SplitAndBalanceRef

## Content

<div class="doc-site-dotnet-api-container">



<h1 id="GrapeCity_Documents_Text_TextLayout_SplitAndBalanceRef_" data-uid="GrapeCity.Documents.Text.TextLayout.SplitAndBalanceRef*">SplitAndBalanceRef Method
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>



<a id="GrapeCity_Documents_Text_TextLayout_SplitAndBalanceRef_" data-uid="GrapeCity.Documents.Text.TextLayout.SplitAndBalanceRef*"></a>
<h4 id="GrapeCity_Documents_Text_TextLayout_SplitAndBalanceRef_GrapeCity_Documents_Text_PageSplitArea___GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout__" data-uid="GrapeCity.Documents.Text.TextLayout.SplitAndBalanceRef(GrapeCity.Documents.Text.PageSplitArea[],GrapeCity.Documents.Text.TextSplitOptions,GrapeCity.Documents.Text.TextLayout@)">SplitAndBalanceRef(PageSplitArea[], TextSplitOptions, ref TextLayout)</h4>
<div class="markdown level1 summary"><p>Fits all or the first portion of the current text layout into one or more layout areas (such as page columns).
If the whole text did not fit into the provided areas, the rest is moved into a new
<a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a> instance specified by the output parameter <code class="paramref">rest</code>.</p>
<p>
If the whole text fits in the specified areas (i.e. <code class="paramref">rest</code> is empty), the content is equally distributed between all areas,
which in the case of page columns results in columns of equal height (balanced).
</p>
For details on why providing a reference to an existing <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a> may be beneficial,
see the remarks on the <a class="xref" href="GrapeCity.Documents.Text.TextLayout.SplitRef.html#GrapeCity_Documents_Text_TextLayout_SplitRef_GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout__">SplitRef(TextSplitOptions, ref TextLayout)</a> method.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
  <pre><code class="lang-csharp hljs">public SplitResult SplitAndBalanceRef(PageSplitArea[] pageAreas, TextSplitOptions splitOptions, ref TextLayout rest)</code></pre>
</div>
<div class="codewrapper">
  <pre><code class="lang-vbnet hljs">Public Function SplitAndBalanceRef(pageAreas As PageSplitArea(), splitOptions As TextSplitOptions, ByRef rest As TextLayout) As SplitResult</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Name</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="GrapeCity.Documents.Text.PageSplitArea.html">PageSplitArea</a>[]</td>
      <td><span class="parametername">pageAreas</span></td>
      <td><p>The array of additional page areas that can be used to layout the text.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="GrapeCity.Documents.Text.TextSplitOptions.html">TextSplitOptions</a></td>
      <td><span class="parametername">splitOptions</span></td>
      <td><p>Options controlling how text is split.</p>
</td>
    </tr>
    <tr>
      <td><a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a></td>
      <td><span class="parametername">rest</span></td>
      <td><p>Recipient for the text that did not fit in the current bounds and additional areas.
If null, a new instance will be created and assigned to this parameter.
If non-null, that <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a> instance will be filled with the text that did not fit.
When rendering large blocks of text, this improves performance by avoiding
the need to initialize a new instance of a <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a> for each split.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-condensed">
  <thead>
    <tr>
      <th>Type</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><a class="xref" href="GrapeCity.Documents.Text.SplitResult.html">SplitResult</a></td>
      <td><p>A value indicating the result of splitting the current text layout.</p>
</td>
    </tr>
  </tbody>
</table>
<h5 id="GrapeCity_Documents_Text_TextLayout_SplitAndBalanceRef_GrapeCity_Documents_Text_PageSplitArea___GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout___seealso">See Also</h5>
<div class="seealso">
    <div><a class="xref" href="GrapeCity.Documents.Text.TextLayout.Split.html#GrapeCity_Documents_Text_TextLayout_Split_GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout__">Split</a>(<a class="xref" href="GrapeCity.Documents.Text.TextSplitOptions.html">TextSplitOptions</a>, out <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a>)</div>
    <div><a class="xref" href="GrapeCity.Documents.Text.TextLayout.SplitAndBalance.html#GrapeCity_Documents_Text_TextLayout_SplitAndBalance_GrapeCity_Documents_Text_PageSplitArea___GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout__">SplitAndBalance</a>(<a class="xref" href="GrapeCity.Documents.Text.PageSplitArea.html">PageSplitArea</a>[], <a class="xref" href="GrapeCity.Documents.Text.TextSplitOptions.html">TextSplitOptions</a>, out <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a>)</div>
    <div><a class="xref" href="GrapeCity.Documents.Text.TextLayout.SplitRef.html#GrapeCity_Documents_Text_TextLayout_SplitRef_GrapeCity_Documents_Text_TextSplitOptions_GrapeCity_Documents_Text_TextLayout__">SplitRef</a>(<a class="xref" href="GrapeCity.Documents.Text.TextSplitOptions.html">TextSplitOptions</a>, ref <a class="xref" href="GrapeCity.Documents.Text.TextLayout.html">TextLayout</a>)</div>
</div>
</div>