Class PivotField

Represents a field in a PivotTable that can be placed in row, column, data, or page area.

Inheritance

object

PivotField

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DRIT.Spreadsheet.Pivot

Assembly: DRIT.Spreadsheet.dll

Syntax

public class PivotField

Constructors

PivotField()

Represents a field in a PivotTable that can be placed in row, column, data, or page area.

Declaration

public PivotField()

Properties

AggregationFunction

Specifies the aggregation function to apply in the subtotal of this field.

Declaration

public AggregationFunction AggregationFunction { get; set; }

Property Value

Type	Description
AggregationFunction

CustomName

Specifies the custom name of the field.

Declaration

public string CustomName { get; set; }

Property Value

Type	Description
string

DataDisplayFormat

Specifies the data display format for this field when it is in the data area. This is an alias for ShowValuesAs using the PivotFieldDataDisplayFormat enum. Excel UI: "PivotTable Analyze > Field Settings > Show Values As" dropdown.

Declaration

public PivotFieldDataDisplayFormat DataDisplayFormat { get; set; }

Property Value

Type	Description
PivotFieldDataDisplayFormat

DisplayCompact

Gets whether the application will display fields compactly in the sheet on which this PivotTable resides.

Declaration

public bool DisplayCompact { get; }

Property Value

Type	Description
bool

DisplaySubtotalsAtTop

Gets whether to display subtotals at the top of the group. Applies only when Outline its true.

Declaration

public bool DisplaySubtotalsAtTop { get; }

Property Value

Type	Description
bool

DragOff

Gets whether the field can be removed from the PivotTable.

Declaration

public bool DragOff { get; }

Property Value

Type	Description
bool

DragToColumn

Gets whether the field can be dragged to the column axis.

Declaration

public bool DragToColumn { get; }

Property Value

Type	Description
bool

DragToData

Gets whether the field can be dragged to the data region.

Declaration

public bool DragToData { get; }

Property Value

Type	Description
bool

DragToPage

Gets whether the field can be dragged to the page region.

Declaration

public bool DragToPage { get; }

Property Value

Type	Description
bool

DragToRow

Gets whether the field can be dragged to the row axis.

Declaration

public bool DragToRow { get; }

Property Value

Type	Description
bool

IncludeNewItemsInFilter

Gets whether manual filter is in inclusive mode

Declaration

public bool IncludeNewItemsInFilter { get; }

Property Value

Type	Description
bool

Index

Gets the index of the field in the PivotFields collection.

Declaration

public int Index { get; }

Property Value

Type	Description
int

InsertBlankRow

Gets whether to insert a blank row after each item.

Declaration

public bool InsertBlankRow { get; }

Property Value

Type	Description
bool

InsertPageBreak

Gets whether to insert a page break after each item.

Declaration

public bool InsertPageBreak { get; }

Property Value

Type	Description
bool

MultipleItemSelectionAllowed

Gets whether the field can have multiple items selected in the page field.

Declaration

public bool MultipleItemSelectionAllowed { get; }

Property Value

Type	Description
bool

Name

Gets the source name of the field.

Declaration

public string Name { get; }

Property Value

Type	Description
string

NumberFormat

Represents the custom display format of numbers and dates.

Declaration

public Format NumberFormat { get; set; }

Property Value

Type	Description
Format

PivotItems

Gets the collection of pivot items for this field.

Declaration

public PivotItemCollection PivotItems { get; }

Property Value

Type	Description
PivotItemCollection

ShowAllItems

Gets whether to show all items for this field.

Declaration

public bool ShowAllItems { get; }

Property Value

Type	Description
bool

ShowInOutlineForm

Gets whether the items in this field should be shown in Outline form.

Declaration

public bool ShowInOutlineForm { get; }

Property Value

Type	Description
bool

ShowValuesAs

Specifies the custom calculation to use for the field.

Declaration

public PivotFieldCustomCalculation ShowValuesAs { get; set; }

Property Value

Type	Description
PivotFieldCustomCalculation