[]
        
(Showing Draft Content)

GrapeCity.Documents.Text.TextLayout.SplitAndBalance

SplitAndBalance Method

SplitAndBalance(PageSplitArea[], TextSplitOptions, out TextLayout)

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).

Declaration
public SplitResult SplitAndBalance(PageSplitArea[] pageAreas, TextSplitOptions splitOptions, out TextLayout rest)
Public Function SplitAndBalance(pageAreas As PageSplitArea(), splitOptions As TextSplitOptions, ByRef rest As TextLayout) As SplitResult
Parameters
Type Name Description
PageSplitArea[] pageAreas

The array of additional page areas that can be used to layout the text.

TextSplitOptions splitOptions

Options controlling how text is split.

TextLayout rest

Output: a new TextLayout instance containing the text that did not fit into the bounds specified by the current TextLayout.

Returns
Type Description
SplitResult

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

See Also