Class PivotGridControlBase

Defines the internal Grid control which is used to form the Pivot Grid control. It derives from SfCellGrid and hence share the basic characteristics of the Cell Grid control.

Inheritance
System.Object
SfCellGrid
PivotGridControlBase
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.PivotGrid
Assembly: Syncfusion.SfPivotGrid.UWP.dll
Syntax
public class PivotGridControlBase : SfCellGrid, INotifyPropertyChanged, IDisposable, ICalcData

Constructors

PivotGridControlBase()

Initializes a new instance of the PivotGridControlBase class.

Declaration
public PivotGridControlBase()

Fields

EngineProperty

Identifies the Engine dependency property.

Declaration
public static DependencyProperty EngineProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

GridLineStrokeProperty

Identifies the GridLineStroke dependency property.

Declaration
public static DependencyProperty GridLineStrokeProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

PivotGridProperty

Identifies the Syncfusion.UI.Xaml.PivotGrid.PivotGridControlBase.PivotGrid dependency property.

Declaration
public static DependencyProperty PivotGridProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ResizeColumnsToFitProperty

Identifies the ResizeColumnsToFit dependency property.

Declaration
public static DependencyProperty ResizeColumnsToFitProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ResizeRowsToFitProperty

Identifies the ResizeRowsToFit dependency property.

Declaration
public static DependencyProperty ResizeRowsToFitProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ShowHeaderCellsToolTipProperty

Identifies the ShowHeaderCellsToolTip dependency property.

Declaration
public static DependencyProperty ShowHeaderCellsToolTipProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

ShowValueCellToolTipProperty

Identifies the ShowValueCellToolTip dependency property.

Declaration
public static DependencyProperty ShowValueCellToolTipProperty
Field Value
Type Description
Windows.UI.Xaml.DependencyProperty

Properties

ColumnHeaderStyle

Gets or sets the style for column header cells.

Declaration
public PivotGridCellStyle ColumnHeaderStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

DataManager

Gets or sets the OLAP data manager.

Declaration
public OlapDataManager DataManager { get; set; }
Property Value
Type Description
OlapDataManager

Engine

Gets or sets the engine data for Pivot Grid control.

Declaration
public object Engine { get; set; }
Property Value
Type Description
System.Object

FreezeHeaders

Gets or sets a value indicating whether the header cells are frozen.

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

GridLineStroke

Gets or sets the stroke of grid lines.

Declaration
public Brush GridLineStroke { get; set; }
Property Value
Type Description
Windows.UI.Xaml.Media.Brush

GridLineThickness

Gets or sets the thickness of grid lines.

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

HiddenColumnGroups

Gets or sets the collection of hidden column groups.

Declaration
public List<HiddenGroup> HiddenColumnGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HiddenGroup>

HiddenPivotColumnGroups

Gets or sets the collection of hidden pivot column groups.

Declaration
public Dictionary<int, List<HiddenGroup>> HiddenPivotColumnGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.Collections.Generic.List<HiddenGroup>>

HiddenPivotRowGroups

Gets or sets the collection of hidden pivot row groups.

Declaration
public Dictionary<int, List<HiddenGroup>> HiddenPivotRowGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.Int32, System.Collections.Generic.List<HiddenGroup>>

HiddenRowGroups

Gets or sets the collection of hidden row groups.

Declaration
public List<HiddenGroup> HiddenRowGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HiddenGroup>

HiddenSubTotalsColumnGroups

Gets or sets the collection of hidden subtotal column groups.

Declaration
public List<HiddenGroup> HiddenSubTotalsColumnGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HiddenGroup>

HiddenSubTotalsRowGroups

Gets or sets the collection of hidden subtotal row groups.

Declaration
public List<HiddenGroup> HiddenSubTotalsRowGroups { get; set; }
Property Value
Type Description
System.Collections.Generic.List<HiddenGroup>

Layout

Gets or sets the layout for the Pivot Grid control.

Declaration
public GridLayout Layout { get; set; }
Property Value
Type Description
GridLayout

Model

Gets the model of Pivot Grid control.

Declaration
public PivotGridModel Model { get; }
Property Value
Type Description
PivotGridModel

ResizeColumnsToFit

Gets or sets a value indicating whether to resize the columns to fit the grid based on values or not.

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

ResizeRowsToFit

Gets or sets a value indicating whether to resize the rows to fit the grid based on values or not.

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

RowHeaderStyle

Gets or sets the style for row header cells.

Declaration
public PivotGridCellStyle RowHeaderStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

ShowHeaderCellsToolTip

Gets or sets a value indicating whether to show or hide the tool tip for header cells.

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

ShowValueCellToolTip

Gets or sets a value indicating whether to show or hide the tool tip for value cells.

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

SummaryColumnStyle

Gets or sets the style for summary column cells.

Declaration
public PivotGridCellStyle SummaryColumnStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

SummaryRowStyle

Gets or sets the style for summary row cells.

Declaration
public PivotGridCellStyle SummaryRowStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

ValueCellStyle

Gets or sets the style for value cells.

Declaration
public PivotGridCellStyle ValueCellStyle { get; set; }
Property Value
Type Description
PivotGridCellStyle

The value cells style.

ValueCellTextAlignment

Gets or sets the horizontal alignment of text in value cells.

Declaration
public HorizontalAlignment ValueCellTextAlignment { get; set; }
Property Value
Type Description
Windows.UI.Xaml.HorizontalAlignment

Methods

add_AfterRefresh(PivotGridDrillDownEventHandler)

Declaration
public void add_AfterRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

add_BeforeRefresh(PivotGridDrillDownEventHandler)

Declaration
public void add_BeforeRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

add_LinkClick(LinkLabelClickEventHandler)

Declaration
public void add_LinkClick(LinkLabelClickEventHandler value)
Parameters
Type Name Description
LinkLabelClickEventHandler value

DataBind()

Binds the data to render the Pivot Grid control.

Declaration
public void DataBind()

DataBind(PivotEngine)

Binds the specified engine data for rendering the Pivot Grid control.

Declaration
public void DataBind(PivotEngine engine)
Parameters
Type Name Description
PivotEngine engine

The pivot engine data.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
protected void Dispose()

InitializeCellRendererCollection()

Initializes the collection of renderer used to render the grid.

Declaration
protected override void InitializeCellRendererCollection()
Overrides

OnCreateModel()

Creates a new instance for GridModel.

Declaration
protected override GridModel OnCreateModel()
Returns
Type Description
GridModel
Overrides

remove_AfterRefresh(PivotGridDrillDownEventHandler)

Declaration
public void remove_AfterRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

remove_BeforeRefresh(PivotGridDrillDownEventHandler)

Declaration
public void remove_BeforeRefresh(PivotGridDrillDownEventHandler value)
Parameters
Type Name Description
PivotGridDrillDownEventHandler value

remove_LinkClick(LinkLabelClickEventHandler)

Declaration
public void remove_LinkClick(LinkLabelClickEventHandler value)
Parameters
Type Name Description
LinkLabelClickEventHandler value

Events

AfterRefresh

Occurs after the data gets refreshed.

Declaration
public event PivotGridDrillDownEventHandler AfterRefresh
Event Type
Type Description
PivotGridDrillDownEventHandler

BeforeRefresh

Occurs before the data gets refreshed.

Declaration
public event PivotGridDrillDownEventHandler BeforeRefresh
Event Type
Type Description
PivotGridDrillDownEventHandler

LinkClick

Occurs when the hyperlink cell is clicked.

Declaration
public event LinkLabelClickEventHandler LinkClick
Event Type
Type Description
LinkLabelClickEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Extension Methods