GrapeCity.Spreadsheet.Commands.PivotTables.PivotTableCommand.CreateFieldSettings

CreateFieldSettings Method

CreateFieldSettings(IPivotTable, IPivotField, string, ConsolidationFunction, PivotFieldCalculation, NumberFormat, int?, int?)

Initializes a new command to modify GrapeCity.Spreadsheet.Commands.PivotTables.PivotTableCommand.PivotTable value field settings.

Declaration

public static Command CreateFieldSettings(IPivotTable pivotTable, IPivotField pivotField, string customName, ConsolidationFunction function, PivotFieldCalculation calculation, NumberFormat numberFormat, int? baseField = null, int? baseItem = null)

Public Shared Function CreateFieldSettings(pivotTable As IPivotTable, pivotField As IPivotField, customName As String, [function] As ConsolidationFunction, calculation As PivotFieldCalculation, numberFormat As NumberFormat, Optional baseField As Integer? = Nothing, Optional baseItem As Integer? = Nothing) As Command

Parameters

Type	Name	Description
IPivotTable	pivotTable	The PivotTable report
IPivotField	pivotField
string	customName	The custom name of the specified field.
ConsolidationFunction	function	A ConsolidationFunction value that represents the subtotal function of the specified field.
PivotFieldCalculation	calculation	A PivotFieldCalculation value that represents the type of calculation performed by the specified field.
NumberFormat	numberFormat	The number format which indicate how to format and render the numeric value of a cell.
int?	baseField	The base field for a custom calculation
int?	baseItem	The item in the base field for a custom calculation.

Returns

Type	Description
Command

CreateFieldSettings(IPivotTable, int, string, ConsolidationFunction?, bool?, LayoutFormType?, bool?, SubtotalLocationType?, bool?, bool?, bool?, string)

Initializes a new command to modify IPivotTable field settings.

Declaration

public static Command CreateFieldSettings(IPivotTable pivotTable, int fieldIndex, string customName = null, ConsolidationFunction? subtotals = null, bool? includeNewItemsInFilter = null, LayoutFormType? layoutForm = null, bool? layoutCompactRow = null, SubtotalLocationType? layoutSubtotalLocation = null, bool? repeatLabels = null, bool? layoutBlankLine = null, bool? showAllItems = null, string numberFormat = null)

Public Shared Function CreateFieldSettings(pivotTable As IPivotTable, fieldIndex As Integer, Optional customName As String = Nothing, Optional subtotals As ConsolidationFunction? = Nothing, Optional includeNewItemsInFilter As Boolean? = Nothing, Optional layoutForm As LayoutFormType? = Nothing, Optional layoutCompactRow As Boolean? = Nothing, Optional layoutSubtotalLocation As SubtotalLocationType? = Nothing, Optional repeatLabels As Boolean? = Nothing, Optional layoutBlankLine As Boolean? = Nothing, Optional showAllItems As Boolean? = Nothing, Optional numberFormat As String = Nothing) As Command

Parameters

Type	Name	Description
IPivotTable	pivotTable
int	fieldIndex
string	customName
ConsolidationFunction?	subtotals
bool?	includeNewItemsInFilter
LayoutFormType?	layoutForm
bool?	layoutCompactRow
SubtotalLocationType?	layoutSubtotalLocation
bool?	repeatLabels
bool?	layoutBlankLine
bool?	showAllItems
string	numberFormat

Returns

Type	Description
Command