Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelSubtotalOptions

OfficeIMO.Excel.Reports

Namespace
OfficeIMO.Excel.Reports
Assembly
OfficeIMO.Excel
Source revision
e163ccb36643 with working tree changes
Modifiers
sealed

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

Inheritance

  • object
  • ExcelSubtotalOptions

Usage

Explore 2 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.

Accepted by parameters 2

Constructors

public ExcelSubtotalOptions() #

Properties

public int HeaderRow { get; set; } #

Header row that contains source labels.

public int DataStartRow { get; set; } #

First source data row.

public int DataEndRow { get; set; } #

Last source data row.

public int GroupColumn { get; set; } #

Column containing group keys.

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

Columns to aggregate into subtotal formulas.

public int? SummaryStartRow { get; set; } #

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

public ExcelSubtotalFunction Function { get; set; } #

Function used by generated SUBTOTAL formulas.

public bool IncludeHeader { get; set; } #

Whether to write a header row for the summary block.

public bool IncludeGrandTotal { get; set; } #

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

public bool OutlineDetailRows { get; set; } #

Whether to apply Excel row outline metadata to detail groups.

public bool 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.