Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

ExcelPivotDataFieldInfo

OfficeIMO.Excel

Namespace
OfficeIMO.Excel
Assembly
OfficeIMO.Excel
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

Describes a data field in an existing pivot table.

Inheritance

  • object
  • ExcelPivotDataFieldInfo

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.

Returned or exposed by 1

Accepted by parameters 1

Constructors

ExcelPivotDataFieldInfo 5 overloads
public ExcelPivotDataFieldInfo(string fieldName, ExcelPivotDataFunction function, string? displayName) #

Creates a data field info instance.

Parameters

fieldName string required
function OfficeIMO.Excel.ExcelPivotDataFunction required
displayName string? required
public ExcelPivotDataFieldInfo(string fieldName, ExcelPivotDataFunction function, string? displayName, uint? numberFormatId) #

Creates a data field info instance.

Parameters

fieldName string required
function OfficeIMO.Excel.ExcelPivotDataFunction required
displayName string? required
numberFormatId uint? required
public ExcelPivotDataFieldInfo(string fieldName, ExcelPivotDataFunction function, string? displayName, uint? numberFormatId, string? numberFormatCode) #

Creates a data field info instance.

Parameters

fieldName string required
function OfficeIMO.Excel.ExcelPivotDataFunction required
displayName string? required
numberFormatId uint? required
numberFormatCode string? required
public ExcelPivotDataFieldInfo(string fieldName, ExcelPivotDataFunction function, string? displayName, uint? numberFormatId, ExcelPivotShowDataAs? showDataAs, int? baseField, uint? baseItem) #

Creates a data field info instance.

Parameters

fieldName string required
function OfficeIMO.Excel.ExcelPivotDataFunction required
displayName string? required
numberFormatId uint? required
showDataAs OfficeIMO.Excel.ExcelPivotShowDataAs? required
baseField int? required
baseItem uint? required
public ExcelPivotDataFieldInfo(string fieldName, ExcelPivotDataFunction function, string? displayName, uint? numberFormatId, string? numberFormatCode, ExcelPivotShowDataAs? showDataAs, int? baseField, uint? baseItem) #

Creates a data field info instance.

Parameters

fieldName string required
function OfficeIMO.Excel.ExcelPivotDataFunction required
displayName string? required
numberFormatId uint? required
numberFormatCode string? required
showDataAs OfficeIMO.Excel.ExcelPivotShowDataAs? required
baseField int? required
baseItem uint? required

Properties

public string FieldName { get; } #

Gets the source field name.

public ExcelPivotDataFunction Function { get; } #

Gets the aggregation function.

public string? DisplayName { get; } #

Gets the display name for the data field.

public uint? 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 ExcelPivotShowDataAs? ShowDataAs { get; } #

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

public int? BaseField { get; } #

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

public uint? BaseItem { get; } #

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