API Reference

Class

ExcelSubtotalOptions

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Options for creating a reusable subtotal summary block from worksheet rows.

Inheritance

  • Object
  • ExcelSubtotalOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Constructors

public ExcelSubtotalOptions() #

Properties

public Int32 HeaderRow { get; set; } #

Header row that contains source labels.

public Int32 DataStartRow { get; set; } #

First source data row.

public Int32 DataEndRow { get; set; } #

Last source data row.

public Int32 GroupColumn { get; set; } #

Column containing group keys.

public IReadOnlyList<Int32> ValueColumns { get; set; } #

Columns to aggregate into subtotal formulas.

public Nullable<Int32> SummaryStartRow { get; set; } #

First row for the generated summary block. Defaults to two rows below DataEndRow.

public ExcelSubtotalFunction Function { get; set; } #

Function used by generated SUBTOTAL formulas.

public Boolean IncludeHeader { get; set; } #

Whether to write a header row for the summary block.

public Boolean IncludeGrandTotal { get; set; } #

Whether to add a grand total row after group subtotal rows.

public Boolean OutlineDetailRows { get; set; } #

Whether to apply Excel row outline metadata to detail groups.

public Boolean HideDetailRows { get; set; } #

Hide detail rows when applying outline metadata.

public Byte OutlineLevel { get; set; } #

Outline level used for grouped detail rows.

public String LabelSuffix { get; set; } #

Text appended to each group key in the subtotal label cell.

public String BlankGroupLabel { get; set; } #

Label used when the group key cell is blank.

public String GrandTotalLabel { get; set; } #

Label used for the optional grand total row.