GemBox.Document
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    PaginatorOptions Class

    Namespace:
    GemBox.Document
    Assembly:
    GemBox.Document.dll

    Represents options used to specify which parts of the document to update while paginating it.

    • C#
    • VB.NET
    public sealed class PaginatorOptions
    Public NotInheritable Class PaginatorOptions
    Inheritance:
    Object
    PaginatorOptions

    Constructors

    PaginatorOptions()

    Initializes a new instance of the PaginatorOptions class.

    • C#
    • VB.NET
    public PaginatorOptions()
    Public Sub New

    Properties

    TrimExcessTableCellSpans

    Gets or sets a value indicating whether to trim excess table cell spans while paginating the document.

    For example, table with two rows (row 1: cell[column span = 2], cell[column span = 2]) (row 2: cell[column span = 4]) will be trimmed to (row 1: cell[column span = 1], cell[column span = 1]) (row 2: cell[column span = 2]).

    • C#
    • VB.NET
    public bool TrimExcessTableCellSpans { get; set; }
    Public Property TrimExcessTableCellSpans As Boolean
    Property Value
    Boolean

    true to trim excess table cell spans while paginating the document; otherwise, false.

    UpdateFields

    Gets or sets a value indicating whether to update fields while paginating the document.

    ResultInlines will be reset while paginating the document for each supported field in the document.

    Currently supported fields are: Page, PageRef, NumPages, Section, SectionPages and Seq.

    • C#
    • VB.NET
    public bool UpdateFields { get; set; }
    Public Property UpdateFields As Boolean
    Property Value
    Boolean

    true to update fields while paginating the document; otherwise, false.

    Remarks

    If field is contained in header or footer, then its result will be equal to result visible on the last page which contains that header or footer.

    UpdateTableCellWidths

    Gets or sets a value indicating whether to update table cell widths while paginating the document.

    PreferredWidth will be set to a value calculated while paginating the document for each cell in a table.

    • C#
    • VB.NET
    public bool UpdateTableCellWidths { get; set; }
    Public Property UpdateTableCellWidths As Boolean
    Property Value
    Boolean

    true to update table cell widths while paginating the document; otherwise, false.

    UpdateTableColumnWidths

    Gets or sets a value indicating whether to update table column widths while paginating the document.

    PreferredWidth will be set to a value calculated while paginating the document for each column in a table.

    • C#
    • VB.NET
    public bool UpdateTableColumnWidths { get; set; }
    Public Property UpdateTableColumnWidths As Boolean
    Property Value
    Boolean

    true to update table column widths while paginating the document; otherwise, false.

    UpdateTableWidth

    Gets or sets a value indicating whether to update table width while paginating the document.

    PreferredWidth will be set to a value calculated while paginating the document for each table in the document.

    • C#
    • VB.NET
    public bool UpdateTableWidth { get; set; }
    Public Property UpdateTableWidth As Boolean
    Property Value
    Boolean

    true to update table width while paginating the document; otherwise, false.

    UpdateTextBoxHeights

    Gets or sets a value indicating whether to update text box heights while paginating the document.

    TextBox.Layout.Size.Height will be set to a value calculated while paginating the document for each text box in a document.

    • C#
    • VB.NET
    public bool UpdateTextBoxHeights { get; set; }
    Public Property UpdateTextBoxHeights As Boolean
    Property Value
    Boolean

    true to update text box heights while paginating the document; otherwise, false.

    See Also

    GetPaginator(PaginatorOptions)
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.