Back to all docs
API Reference / Telerik.Windows.Controls / RadPivotGrid
New to Telerik UI for WPF? Start a free 30-day trial

RadPivotGrid

Class

Represents a control that displays data in a customizable pivot.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Pivot.dll

Syntax:
C#
[TelerikToolboxCategory("Data")]
public class RadPivotGrid : TableBase

Inheritance: objectTableBaseRadPivotGrid

Inherited Members TableBase.AllowSelectionPropertyTableBase.EditProviderPropertyTableBase.ColumnWidthPropertyTableBase.RowHeightPropertyTableBase.CellTooltipStylePropertyTableBase.RowGroupTooltipStylePropertyTableBase.ColumnGroupTooltipStylePropertyTableBase.ColumnSubTotalsPositionPropertyTableBase.ColumnGrandTotalsPositionPropertyTableBase.RowSubTotalsPositionPropertyTableBase.RowGrandTotalsPositionPropertyTableBase.HorizontalLayoutPropertyTableBase.VerticalLayoutPropertyTableBase.QuickStylePropertyTableBase.CellTextVerticalAlignmentPropertyTableBase.CellTextAlignmentPropertyTableBase.CellTextPaddingPropertyTableBase.RowHeaderStylePropertyTableBase.RowHeaderStyleSelectorPropertyTableBase.RowHeaderTemplatePropertyTableBase.RowHeaderTemplateSelectorPropertyTableBase.ColumnHeaderStylePropertyTableBase.ColumnHeaderStyleSelectorPropertyTableBase.ColumnHeaderTemplatePropertyTableBase.ColumnHeaderTemplateSelectorPropertyTableBase.CellTemplatePropertyTableBase.CellTemplateSelectorPropertyTableBase.RowToolTipIsEnabledPropertyTableBase.ColumnToolTipIsEnabledPropertyTableBase.CellToolTipIsEnabledPropertyTableBase.Refresh()TableBase.MeasureOverride(Size)TableBase.OnMouseWheel(MouseWheelEventArgs)TableBase.OnEditEnded(CellAggregateValue, object)TableBase.OnSelectionChanged()TableBase.OnPropertyChanged(DependencyPropertyChangedEventArgs)TableBase.AllowSelectionTableBase.EditProviderTableBase.ColumnWidthTableBase.RowHeightTableBase.RowGroupTooltipStyleTableBase.ColumnGroupTooltipStyleTableBase.CellTooltipStyleTableBase.ColumnSubTotalsPositionTableBase.ColumnGrandTotalsPositionTableBase.RowSubTotalsPositionTableBase.RowGrandTotalsPositionTableBase.VerticalLayoutTableBase.HorizontalLayoutTableBase.QuickStyleTableBase.CellTextAlignmentTableBase.CellTextVerticalAlignmentTableBase.CellTextPaddingTableBase.RowHeaderStyleTableBase.RowHeaderStyleSelectorTableBase.RowHeaderTemplateTableBase.RowHeaderTemplateSelectorTableBase.ColumnHeaderStyleTableBase.ColumnHeaderStyleSelectorTableBase.ColumnHeaderTemplateTableBase.ColumnHeaderTemplateSelectorTableBase.CellTemplateTableBase.CellTemplateSelectorTableBase.RowToolTipIsEnabledTableBase.ColumnToolTipIsEnabledTableBase.CellToolTipIsEnabledTableBase.SelectionChangedTableBase.EditEnded...

Constructors

RadPivotGrid()

Initializes a new instance of the RadPivotGrid class.

C#
public RadPivotGrid()

Fields

CanUserResizeColumnsProperty

DependencyProperty

The DependencyProperty that represents the CanUserResizeColumns property.

C#
public static readonly DependencyProperty CanUserResizeColumnsProperty

ColumnGroupsExpandBehaviorProperty

DependencyProperty

Identifies the ColumnGroupsExpandBehavior dependency property.

C#
public static readonly DependencyProperty ColumnGroupsExpandBehaviorProperty

DataProviderProperty

DependencyProperty

Identifies the DataProvider dependency property.

C#
public static readonly DependencyProperty DataProviderProperty

EmptyValueTextProperty

DependencyProperty

Identifies the EmptyValueText dependency property.

C#
public static readonly DependencyProperty EmptyValueTextProperty

ErrorValueTextProperty

DependencyProperty

Identifies the ErrorValueText dependency property.

C#
public static readonly DependencyProperty ErrorValueTextProperty

IsBusyProperty

DependencyProperty

Identifies the IsBusy read-only dependency property.

C#
public static readonly DependencyProperty IsBusyProperty

MaximumResizeWidthProperty

DependencyProperty

The DependencyProperty that represents the MaximumResizeWidth property.

C#
public static readonly DependencyProperty MaximumResizeWidthProperty

MinimumResizeWidthProperty

DependencyProperty

The DependencyProperty that represents the MinimumResizeWidth property.

C#
public static readonly DependencyProperty MinimumResizeWidthProperty

RowGroupsExpandBehaviorProperty

DependencyProperty

Identifies the RowGroupsExpandBehavior dependency property.

C#
public static readonly DependencyProperty RowGroupsExpandBehaviorProperty

ShowAggregateValuesInlineProperty

DependencyProperty

Identifies the ShowAggregateValuesInline dependency property.

C#
public static readonly DependencyProperty ShowAggregateValuesInlineProperty

Properties

CanUserResizeColumns

Gets or sets a value that indicates whether the user can adjust column widths using the mouse.

C#
public bool CanUserResizeColumns { get; set; }

ColumnGroups

Gets a read-only list of the root column IGroups.

C#
public IReadOnlyList<IGroup> ColumnGroups { get; }

ColumnGroupsExpandBehavior

Gets or sets the behavior that will set the expand or collapse state for column IGroups.

C#
public IItemExpandBehavior<ExpandBehaviorParameters> ColumnGroupsExpandBehavior { get; set; }

ColumnLevels

Gets the depth of the columns.

C#
public int ColumnLevels { get; }

DataProvider

Gets or sets the data provider.

C#
public IDataProvider DataProvider { get; set; }

EmptyValueText

Gets or sets the string to be displayed in cells with no value.

C#
public string EmptyValueText { get; set; }

ErrorValueText

Gets or sets the string ro be displayed in cells with an error.

C#
public string ErrorValueText { get; set; }

IsBusy

Gets a value indicating whether this instance is processing or loading data.

C#
public bool IsBusy { get; }

MaximumResizeWidth

Gets or sets the maximum resize width of columns in the control. The default is PositiveInfinity.

C#
public double MaximumResizeWidth { get; set; }

MinimumResizeWidth

Gets or sets the minimum resize width of columns in the control. The default is 20.

C#
public double MinimumResizeWidth { get; set; }

RowGroups

Gets a read-only list of the root row IGroups.

C#
public IReadOnlyList<IGroup> RowGroups { get; }

RowGroupsExpandBehavior

Gets or sets the behavior that will set the expand or collapse state for row IGroups.

C#
public IItemExpandBehavior<ExpandBehaviorParameters> RowGroupsExpandBehavior { get; set; }

RowLevels

Gets the depth of the rows.

C#
public int RowLevels { get; }

ShowAggregateValuesInline

Gets or sets value indicating if subtotals should be inlined for aggregate groups. This affects groups at the same axis as the AggregatesPosition with level greater than or equal AggregatesLevel and AggregateDescriptions.Count is greater than one and axis Layout is not Tabular.

C#
public bool ShowAggregateValuesInline { get; set; }

Methods

CollapseColumn(IGroup)

Collapse an IGroup in the column area.

C#
public void CollapseColumn(IGroup group)
Parameters:groupIGroup

The group that will be collapsed.

CollapseRow(IGroup)

Collapse an IGroup in the row area.

C#
public void CollapseRow(IGroup group)
Parameters:groupIGroup

The group that will be collapsed.

ExpandColumn(IGroup)

Expand an IGroup in the column area.

C#
public void ExpandColumn(IGroup group)
Parameters:groupIGroup

The group that will be expanded.

ExpandRow(IGroup)

Expand an IGroup in the row area.

C#
public void ExpandRow(IGroup group)
Parameters:groupIGroup

The group that will be expanded.

GenerateExport()

Generate export model that describe each cell in RadPivotGrid.

C#
public PivotExportModel GenerateExport()
Returns:

PivotExportModel

The export model that describe each cell in RadPivotGrid.

GenerateExport(bool, bool)

Generate export model that describe each cell in RadPivotGrid.

C#
public PivotExportModel GenerateExport(bool ignoreCollapsedGroups, bool includeValueFormatting = true)
Parameters:ignoreCollapsedGroupsbool

Indicates whether to ignore collapsed groups when generating the export.

includeValueFormattingbool

Indicates whether to include cell value formatting in the generated export.

Returns:

PivotExportModel

The export model that describe each cell in RadPivotGrid.

IsColumnCollapsed(IGroup)

Gets a value that indicates if an IGroup in the column area is collapsed.

C#
public bool IsColumnCollapsed(IGroup group)
Parameters:groupIGroup

The IGroup.

Returns:

bool

true if the IGroup is collapsed; otherwise, false.

IsRowCollapsed(IGroup)

Gets a value that indicates if an IGroup in the row area is collapsed.

C#
public bool IsRowCollapsed(IGroup group)
Parameters:groupIGroup

The IGroup.

Returns:

bool

true if the IGroup is collapsed; otherwise, false.

OnAllowSelectionChanged(bool, bool)

Called when the AllowSelection of the control has changed.

C#
protected override void OnAllowSelectionChanged(bool newValue, bool oldValue)
Parameters:newValuebool

The new value.

oldValuebool

The old value.

Overrides: TableBase.OnAllowSelectionChanged(bool, bool)

OnApplyTemplate()

C#
public override void OnApplyTemplate()

Overrides: TableBase.OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

In this article
DefinitionConstructorsRadPivotGrid()FieldsCanUserResizeColumnsPropertyColumnGroupsExpandBehaviorPropertyDataProviderPropertyEmptyValueTextPropertyErrorValueTextPropertyIsBusyPropertyMaximumResizeWidthPropertyMinimumResizeWidthPropertyRowGroupsExpandBehaviorPropertyShowAggregateValuesInlinePropertyPropertiesCanUserResizeColumnsColumnGroupsColumnGroupsExpandBehaviorColumnLevelsDataProviderEmptyValueTextErrorValueTextIsBusyMaximumResizeWidthMinimumResizeWidthRowGroupsRowGroupsExpandBehaviorRowLevelsShowAggregateValuesInlineMethodsCollapseColumn(IGroup)CollapseRow(IGroup)ExpandColumn(IGroup)ExpandRow(IGroup)GenerateExport()GenerateExport(bool, bool)IsColumnCollapsed(IGroup)IsRowCollapsed(IGroup)OnAllowSelectionChanged(bool, bool)OnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)
Not finding the help you need?
Contact Support