Class PivotItem

Enacapulates the information needed to define a PivotItem, for either a row/column Pivot.

Inheritance
System.Object
PivotItem
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Implementation.PivotAnalysis
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class PivotItem : INotifyPropertyChanged
Remarks

A PivotItem is a property in the underlying data objects that is used to group the data in a PivotTable. You can add PivotItems to both the PivotColumns and PivotRows collection in a mutually exclusive manner.

Constructors

PivotItem()

Declaration
public PivotItem()

Properties

AllowFilter

Gets or sets whether this calculation column can be filtered when "RowPivotsOnly" is set to true in the PivotEngine.

Declaration
public bool AllowFilter { get; set; }
Property Value
Type
System.Boolean

AllowRunTimeGroupByField

Gets or sets the value to enable/disable grouping for this PivotItem. Default value is true.

Declaration
public bool AllowRunTimeGroupByField { get; set; }
Property Value
Type
System.Boolean

AllowSort

Gets or sets whether this calculation column can be sorted when "RowPivotsOnly" is set to true in the PivotEngine.

Declaration
public bool AllowSort { get; set; }
Property Value
Type
System.Boolean

Comparer

Gets or sets the IComparer object used for sorting. If this value is null, then sorting is done assuming that this field is IComparable.

Declaration
public IComparer Comparer { get; set; }
Property Value
Type
System.Collections.IComparer

Gets or sets whether the PivotItem should be hyperlinked when "RowPivotsOnly" is set to true in the PivotEngine.

Declaration
public bool EnableHyperlinks { get; set; }
Property Value
Type
System.Boolean

FieldCaption

Gets or sets the title you want to see in the header of this PivotItem.

Declaration
public string FieldCaption { get; set; }
Property Value
Type
System.String

FieldHeader

Gets or sets the title you want to see in the header of this PivotItem.

Declaration
public string FieldHeader { get; set; }
Property Value
Type
System.String

FieldMappingName

Gets or sets the property's mapping name.

Declaration
public string FieldMappingName { get; set; }
Property Value
Type
System.String

Format

Gets or sets the format for the PivotItem.

Declaration
public string Format { get; set; }
Property Value
Type
System.String

ShowSubTotal

Gets or sets whether the sub-total of PivotItems can be shown or hidden.

Declaration
public bool ShowSubTotal { get; set; }
Property Value
Type
System.Boolean

Summary

Gets or sets the summary for calculations use.

Declaration
public SummaryBase Summary { get; set; }
Property Value
Type
SummaryBase

SummaryType

Gets or sets the summary type for calculations use.

Declaration
public SummaryType SummaryType { get; set; }
Property Value
Type
SummaryType

TotalHeader

Gets or sets the string that you want to append to the PivotItem's summary cells.

Declaration
public string TotalHeader { get; set; }
Property Value
Type
System.String

Width

Gets or sets the width of PivotItems to set the column width of RowHeaders Its's only applicable for PivotItems which are added in PivotRows

Declaration
public double Width { get; set; }
Property Value
Type
System.Double

Events

PropertyChanged

Event triggered when the property of the PivotItem is changed.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged