API Reference

Class

ExcelPivotDataFieldInfo

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Describes a data field in an existing pivot table.

Inheritance

  • Object
  • ExcelPivotDataFieldInfo

Usage

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

Returned or exposed by

Accepted by parameters

Constructors

ExcelPivotDataFieldInfo 5 overloads
public ExcelPivotDataFieldInfo(String fieldName, DataConsolidateFunctionValues function, String displayName) #

Creates a data field info instance.

Parameters

fieldName System.String requiredposition: 0
function DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues requiredposition: 1
displayName System.String requiredposition: 2
public ExcelPivotDataFieldInfo(String fieldName, DataConsolidateFunctionValues function, String displayName, Nullable<UInt32> numberFormatId) #

Creates a data field info instance.

Parameters

fieldName System.String requiredposition: 0
function DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues requiredposition: 1
displayName System.String requiredposition: 2
numberFormatId System.Nullable{System.UInt32} requiredposition: 3
public ExcelPivotDataFieldInfo(String fieldName, DataConsolidateFunctionValues function, String displayName, Nullable<UInt32> numberFormatId, String numberFormatCode) #

Creates a data field info instance.

Parameters

fieldName System.String requiredposition: 0
function DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues requiredposition: 1
displayName System.String requiredposition: 2
numberFormatId System.Nullable{System.UInt32} requiredposition: 3
numberFormatCode System.String requiredposition: 4
public ExcelPivotDataFieldInfo(String fieldName, DataConsolidateFunctionValues function, String displayName, Nullable<UInt32> numberFormatId, Nullable<ShowDataAsValues> showDataAs, Nullable<Int32> baseField, Nullable<UInt32> baseItem) #

Creates a data field info instance.

Parameters

fieldName System.String requiredposition: 0
function DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues requiredposition: 1
displayName System.String requiredposition: 2
numberFormatId System.Nullable{System.UInt32} requiredposition: 3
showDataAs System.Nullable{DocumentFormat.OpenXml.Spreadsheet.ShowDataAsValues} requiredposition: 4
baseField System.Nullable{System.Int32} requiredposition: 5
baseItem System.Nullable{System.UInt32} requiredposition: 6
public ExcelPivotDataFieldInfo(String fieldName, DataConsolidateFunctionValues function, String displayName, Nullable<UInt32> numberFormatId, String numberFormatCode, Nullable<ShowDataAsValues> showDataAs, Nullable<Int32> baseField, Nullable<UInt32> baseItem) #

Creates a data field info instance.

Parameters

fieldName System.String requiredposition: 0
function DocumentFormat.OpenXml.Spreadsheet.DataConsolidateFunctionValues requiredposition: 1
displayName System.String requiredposition: 2
numberFormatId System.Nullable{System.UInt32} requiredposition: 3
numberFormatCode System.String requiredposition: 4
showDataAs System.Nullable{DocumentFormat.OpenXml.Spreadsheet.ShowDataAsValues} requiredposition: 5
baseField System.Nullable{System.Int32} requiredposition: 6
baseItem System.Nullable{System.UInt32} requiredposition: 7

Properties

public String FieldName { get; } #

Gets the source field name.

public DataConsolidateFunctionValues Function { get; } #

Gets the aggregation function.

public String DisplayName { get; } #

Gets the display name for the data field.

public Nullable<UInt32> NumberFormatId { get; } #

Gets the number format id applied to the data field.

public String NumberFormatCode { get; } #

Gets the custom number format code applied to the data field, when it can be resolved from workbook styles.

public Nullable<ShowDataAsValues> ShowDataAs { get; } #

Gets the show-values-as calculation mode applied to the data field.

public Nullable<Int32> BaseField { get; } #

Gets the base field index for show-values-as calculations that require one.

public Nullable<UInt32> BaseItem { get; } #

Gets the base item index for show-values-as calculations that require one.