Documents for PDF .NET Edition
GrapeCity.Documents.Common Assembly / GrapeCity.Documents.Text Namespace / TextLayout Class / SplitAndBalance Method
The array of additional page areas that can be used to layout the text.
Options controlling how text is split.
Output: a new TextLayout instance containing the text that did not fit into the bounds specified by the current TextLayout.

In This Topic
    SplitAndBalance Method (TextLayout)
    In This Topic
    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 TextLayout instance specified by the output parameter rest.

    If the whole text fits in the specified areas (i.e. rest is empty), the content is equally distributed between all areas, which in the case of page columns results in columns of equal height (balanced).

    Syntax
    'Declaration
     
    Public Function SplitAndBalance( _
       ByVal pageAreas() As PageSplitArea, _
       ByVal splitOptions As TextSplitOptions, _
       ByRef rest As TextLayout _
    ) As SplitResult
    public SplitResult SplitAndBalance( 
       PageSplitArea[] pageAreas,
       TextSplitOptions splitOptions,
       out TextLayout rest
    )

    Parameters

    pageAreas
    The array of additional page areas that can be used to layout the text.
    splitOptions
    Options controlling how text is split.
    rest
    Output: a new TextLayout instance containing the text that did not fit into the bounds specified by the current TextLayout.

    Return Value

    A value indicating the result of splitting the current text layout.
    See Also