PaginatorOptions Class

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

Represents options used to specify which parts of the document to update while paginating it and which pages of the document should be returned in the paginator.

public sealed class PaginatorOptions
Public NotInheritable Class PaginatorOptions
Inheritance:
System.Object
PaginatorOptions

Constructors

PaginatorOptions()

Initializes a new instance of the PaginatorOptions class.

public PaginatorOptions()
Public Sub New

Properties

PageCount

Gets or sets the number of pages that should be contained in the paginator.

public int PageCount { get; set; }
Public Property PageCount As Integer
Property Value
System.Int32

The number of pages that should be contained in the paginator.

Remarks

The default value is System.Int32.MaxValue (all pages).

Even if this property is set, the whole document needs to be first paginated. This property only narrows down the returned paginator. Therefore, other properties in this class have effect on the whole document.

PageNumber

Gets or sets the zero-based page number that should be returned as the first page of the paginator.

public int PageNumber { get; set; }
Public Property PageNumber As Integer
Property Value
System.Int32

The zero-based page number that should be returned as the first page of the paginator.

Remarks

Even if this property is set, the whole document needs to be first paginated. This property only narrows down the returned paginator. Therefore, other properties in this class have effect on the whole document.

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

public bool TrimExcessTableCellSpans { get; set; }
Public Property TrimExcessTableCellSpans As Boolean
Property Value
System.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.

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

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

public bool UpdateFields { get; set; }
Public Property UpdateFields As Boolean
Property Value
System.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.

public bool UpdateTableCellWidths { get; set; }
Public Property UpdateTableCellWidths As Boolean
Property Value
System.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.

public bool UpdateTableColumnWidths { get; set; }
Public Property UpdateTableColumnWidths As Boolean
Property Value
System.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.

public bool UpdateTableWidth { get; set; }
Public Property UpdateTableWidth As Boolean
Property Value
System.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.

public bool UpdateTextBoxHeights { get; set; }
Public Property UpdateTextBoxHeights As Boolean
Property Value
System.Boolean

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

Events

ProgressChanged

Occurs when progress of paginating a document has changed.

public event EventHandler<OperationProgressChangedEventArgs> ProgressChanged
Public Event ProgressChanged As EventHandler(Of OperationProgressChangedEventArgs)
Event Type
System.EventHandler<OperationProgressChangedEventArgs>

See Also