OfficeIMO

API Reference

Class

ExcelPivotDataField

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Describes a data field in a pivot table (field name + aggregation).

Inheritance

  • Object
  • ExcelPivotDataField

Constructors

public ExcelPivotDataField(String fieldName, Nullable<DataConsolidateFunctionValues> function = null, String displayName = null, Nullable<UInt32> numberFormatId = null) #

Creates a pivot data field definition.

Parameters

fieldName System.String requiredposition: 0
Header name from the source range.
function System.Nullable{DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues} = null optionalposition: 1
Aggregation function (Sum, Count, Average, ...).
displayName System.String = null optionalposition: 2
Optional display name for the data field.
numberFormatId System.Nullable{System.UInt32} = null optionalposition: 3
Optional number format id to apply to the data field.

Properties

public String FieldName { get; } #

Gets the source field name.

public DataConsolidateFunctionValues Function { get; } #

Gets the aggregation function.

public String DisplayName { get; } #

Gets the optional display name for the data field.

public Nullable<UInt32> NumberFormatId { get; } #

Gets the optional number format id for the data field.