GrapeCity.Documents.Text.TextSplitOptions

Class TextSplitOptions

Namespace

GrapeCity.Documents.Text

Assembly

GcDocs.Imaging.dll

Provides options for text splitting.

public class TextSplitOptions

Inheritance

object

TextSplitOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

TextSplitOptions()

Initializes a new instance of the TextSplitOptions class.

public TextSplitOptions()

TextSplitOptions(TextLayout)

Initializes a new instance of the TextSplitOptions class copying data from the given TextLayout.

public TextSplitOptions(TextLayout textLayout)

Parameters

textLayout TextLayout

TextLayout to be used as the source of data for a new instance of TextSplitOptions.

TextSplitOptions(TextSplitOptions)

Initializes a new instance of the TextSplitOptions class copying data from another instance of TextSplitOptions.

public TextSplitOptions(TextSplitOptions splitOptions)

Parameters

splitOptions TextSplitOptions

TextSplitOptions to be used as the source of data for a new instance of TextSplitOptions.

Properties

AddSpacingAfterLastLine

Gets or sets a value indicating whether a line spacing should be added after the last line of the current TextLayout after splitting.

public bool AddSpacingAfterLastLine { get; set; }

Property Value

bool

AllowMovingAllToRest

Gets or sets a value indicating whether, if no part of the content can fit in the current layout, to move all content to rest TextLayout. The default is false.

public bool AllowMovingAllToRest { get; set; }

Property Value

bool

KeepParagraphLinesTogether

Gets or sets a value indicating whether paragraphs should be kept together (cannot be split between pages or columns).

public bool KeepParagraphLinesTogether { get; set; }

Property Value

bool

LineGapBeforeFirstLine

Gets or sets a value indicating whether the typographic line gap should be added before the first line of the rest TextLayout.

public bool LineGapBeforeFirstLine { get; set; }

Property Value

bool

MinLinesInFirstParagraph

Gets or sets the minimum number of lines on the last page (or at the ending of the first paragraph on the next page) to prevent widows.

public int MinLinesInFirstParagraph { get; set; }

Property Value

int

MinLinesInLastParagraph

Gets or sets the minimum number of lines that must appear at the beginning of the last paragraph to prevent orphans.

public int MinLinesInLastParagraph { get; set; }

Property Value

int

RestColumnWidth

Gets or sets the width of the layout box measured from left or right margin for the rest of the text after splitting, in graphic units.

public float? RestColumnWidth { get; set; }

Property Value

float?

RestMarginBottom

Gets or sets the bottom margin of the layout box for the rest of the text after splitting, in graphic units.

public float RestMarginBottom { get; set; }

Property Value

float

RestMarginLeft

Gets or sets the left margin of the layout box for the rest of the text after splitting, in graphic units.

public float RestMarginLeft { get; set; }

Property Value

float

RestMarginRight

Gets or sets the right margin of the layout box for the rest of the text after splitting, in graphic units.

public float RestMarginRight { get; set; }

Property Value

float

RestMarginTop

Gets or sets the top margin of the layout box for the rest of the text after splitting, in graphic units.

public float RestMarginTop { get; set; }

Property Value

float

RestMaxHeight

Gets or sets the height of the layout box for the rest of the text after splitting, in graphic units.

public float? RestMaxHeight { get; set; }

Property Value

float?

RestMaxWidth

Gets or sets the width of the layout box for the rest of the text after splitting, in graphic units.

public float? RestMaxWidth { get; set; }

Property Value

float?

RestObjectRects

Gets or sets the list of areas occupied by embedded objects for the rest of the text after splitting.

public List<ObjectRect> RestObjectRects { get; set; }

Property Value

System.Collections.Generic.List<T><ObjectRect>

RestRowHeight

Gets or sets the height of the layout box measured from top or bottom margin for the rest of the text after splitting, in graphic units.

public float? RestRowHeight { get; set; }

Property Value

float?