PaginatorOptions Class
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.
- Inheritance:
- System.
Object PaginatorOptions
Constructors
PaginatorOptions()
Initializes a new instance of the Paginator
Properties
PageCount
Gets or sets the number of pages that should be contained in the paginator.
Property Value
- System.
Int32
The number of pages that should be contained in the paginator.
Remarks
The default value is System.
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.
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]).
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.
Result
Currently supported fields are: Page, Page
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.
Preferred
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.
Preferred
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.
Preferred
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.
Text
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.
Event Type
- System.
Event <OperationHandler Progress >Changed Event Args