PdfTablePageSummary
OfficeIMO.Pdf
Per-page table summaries: column aggregates and the rows that show them at the bottom of every page fragment that continues on the next page (for example "Carried forward" or "Page subtotal") and at the top of every continuation fragment (for example "Brought forward").
Inheritance
- object
- PdfTablePageSummary
Remarks
Values reflect the body rows that actually landed on each page after layout. A body row counts toward the page where its first line is drawn. Summary rows are measured with the values they will show, so they never change which rows fit on a page after the values are known. Cells in summary rows and in the table's footer rows can contain the tokens of any declared aggregate (PdfTableAggregate.PageToken, PdfTableAggregate.BroughtForwardToken and PdfTableAggregate.RunningToken). Summary rows use the table's footer styling.
Usage
Explore 3 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 3
Constructors
public PdfTablePageSummary() #Methods
public PdfTableAggregate Add(PdfTableAggregate aggregate) #Adds an aggregate and returns it.
Parameters
- aggregate OfficeIMO.Pdf.PdfTableAggregate
Returns
PdfTableAggregatepublic PdfTablePageSummary AddContinuationHeaderRow(params string[] cells) #Adds a row drawn at the top of every continuation fragment.
Parameters
- cells string[]
Returns
PdfTablePageSummarypublic PdfTablePageSummary AddContinuationHeaderRow(params PdfTableCell[] cells) #Adds a row drawn at the top of every continuation fragment.
Parameters
- cells OfficeIMO.Pdf.PdfTableCell[]
Returns
PdfTablePageSummarypublic PdfTableAggregate Sum(string name, int column, string? format = null, IFormatProvider? formatProvider = null) #Declares a sum aggregate and returns it so its tokens can be used in rows.
Parameters
- name string
- column int
- format string? = null
- formatProvider System.IFormatProvider? = null
Returns
PdfTableAggregateInherited Methods
Properties
public List<PdfTableAggregate> Aggregates { get; } #Aggregates available to summary row tokens.
public List<PdfTableCell[]> ContinuationHeaderRows { get; } #Rows drawn at the top of every continuation fragment, after the repeated header rows. They are drawn only when at least one body row appeared on an earlier page. They are laid out before the page's rows are known, so their cells can use PdfTableAggregate.BroughtForwardToken but not page or running tokens.