PdfTableAggregate
OfficeIMO.Pdf
Declares a numeric aggregate over one column of a table's body rows. The aggregate is computed per page fragment after layout and is shown in summary rows through its tokens.
Inheritance
- object
- PdfTableAggregate
Usage
Explore 4 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
- Method PdfTablePageSummary.Add
- Method PdfTablePageSummary.Sum
- Property PdfTablePageSummary.Aggregates
Accepted by parameters 1
- Method PdfTablePageSummary.Add
Constructors
public PdfTableAggregate(string name, int column, PdfTableAggregateFunction function = Sum) #Creates an aggregate over a table column.
Parameters
- name string
- Name used in tokens such as {page:name}. Letters, digits, '_', '-' and '.' only.
- column int
- Zero-based logical column whose body cell text supplies the values.
- function OfficeIMO.Pdf.PdfTableAggregateFunction = Sum
- Aggregate function. Defaults to PdfTableAggregateFunction.Sum.
Inherited Methods
Properties
public int Column { get; } #Zero-based logical column whose body cell text supplies the values.
public string? Format { get; set; } #Standard or custom .NET numeric format applied to the value, for example N2 or C. When null, sums, minimums and maximums use N2 and counts use N0.
public IFormatProvider? FormatProvider { get; set; } #Culture used to parse body cell text and to format values. When null, the invariant culture is used so output does not depend on the machine that renders the document.
public Func<int, decimal?>? ValueSelector { get; set; } #Optional value source that replaces cell text parsing. It receives the zero-based body row index (the first row after the header rows is 0) and returns the row's value, or null when the row has none.
public string PageToken { get; } #Token for the value of the rows on the current page fragment.
public string BroughtForwardToken { get; } #Token for the value of the rows on all earlier page fragments (brought forward).
public string RunningToken { get; } #Token for the value of all rows up to the end of the current page fragment. In a page footer row it is the carried-forward amount; in the table's footer rows on the last page it is the grand total.