Back to all docs
API Reference / Telerik.Windows.Controls / RadPivotGrid

Class
RadPivotGrid

Represents a control that displays data in a customizable pivot.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Pivot.dll

Syntax:
cs-api-definition
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "Pivot Selection should be in RadPivotGrid.")]
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable", Justification = "Design Choice.")]
[TelerikToolboxCategory("Data")]
[SuppressMessage("Microsoft.Design", "CA1001:TypesThatOwnDisposableFieldsShouldBeDisposable", Justification = "Design Choice.")]
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "Currently not feasible")]
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.

Declaration

cs-api-definition
public RadPivotGrid()

Fields

CanUserResizeColumnsProperty

The DependencyProperty that represents the CanUserResizeColumns property.

Declaration

cs-api-definition
public static readonly DependencyProperty CanUserResizeColumnsProperty

Field Value

DependencyProperty

ColumnGroupsExpandBehaviorProperty

Identifies the ColumnGroupsExpandBehavior dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ColumnGroupsExpandBehaviorProperty

Field Value

DependencyProperty

DataProviderProperty

Identifies the DataProvider dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DataProviderProperty

Field Value

DependencyProperty

EmptyValueTextProperty

Identifies the EmptyValueText dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty EmptyValueTextProperty

Field Value

DependencyProperty

ErrorValueTextProperty

Identifies the ErrorValueText dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ErrorValueTextProperty

Field Value

DependencyProperty

IsBusyProperty

Identifies the IsBusy read-only dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsBusyProperty

Field Value

DependencyProperty

MaximumResizeWidthProperty

The DependencyProperty that represents the MaximumResizeWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty MaximumResizeWidthProperty

Field Value

DependencyProperty

MinimumResizeWidthProperty

The DependencyProperty that represents the MinimumResizeWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty MinimumResizeWidthProperty

Field Value

DependencyProperty

RowGroupsExpandBehaviorProperty

Identifies the RowGroupsExpandBehavior dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty RowGroupsExpandBehaviorProperty

Field Value

DependencyProperty

ShowAggregateValuesInlineProperty

Identifies the ShowAggregateValuesInline dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ShowAggregateValuesInlineProperty

Field Value

DependencyProperty

Properties

CanUserResizeColumns

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

Declaration

cs-api-definition
public bool CanUserResizeColumns { get; set; }

Property Value

bool

ColumnGroups

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

Declaration

cs-api-definition
public IReadOnlyList<IGroup> ColumnGroups { get; }

Property Value

IReadOnlyList<IGroup>

ColumnGroupsExpandBehavior

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

Declaration

cs-api-definition
public IItemExpandBehavior<ExpandBehaviorParameters> ColumnGroupsExpandBehavior { get; set; }

Property Value

IItemExpandBehavior<ExpandBehaviorParameters>

ColumnLevels

Gets the depth of the columns.

Declaration

cs-api-definition
public int ColumnLevels { get; }

Property Value

int

DataProvider

Gets or sets the data provider.

Declaration

cs-api-definition
public IDataProvider DataProvider { get; set; }

Property Value

IDataProvider

EmptyValueText

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

Declaration

cs-api-definition
public string EmptyValueText { get; set; }

Property Value

string

ErrorValueText

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

Declaration

cs-api-definition
public string ErrorValueText { get; set; }

Property Value

string

IsBusy

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

Declaration

cs-api-definition
public bool IsBusy { get; }

Property Value

bool

MaximumResizeWidth

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

Declaration

cs-api-definition
public double MaximumResizeWidth { get; set; }

Property Value

double

MinimumResizeWidth

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

Declaration

cs-api-definition
public double MinimumResizeWidth { get; set; }

Property Value

double

RowGroups

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

Declaration

cs-api-definition
public IReadOnlyList<IGroup> RowGroups { get; }

Property Value

IReadOnlyList<IGroup>

RowGroupsExpandBehavior

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

Declaration

cs-api-definition
public IItemExpandBehavior<ExpandBehaviorParameters> RowGroupsExpandBehavior { get; set; }

Property Value

IItemExpandBehavior<ExpandBehaviorParameters>

RowLevels

Gets the depth of the rows.

Declaration

cs-api-definition
public int RowLevels { get; }

Property Value

int

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.

Declaration

cs-api-definition
public bool ShowAggregateValuesInline { get; set; }

Property Value

bool

Methods

CollapseColumn(IGroup)

Collapse an IGroup in the column area.

Declaration

cs-api-definition
public void CollapseColumn(IGroup group)

Parameters

group

IGroup

The group that will be collapsed.

CollapseRow(IGroup)

Collapse an IGroup in the row area.

Declaration

cs-api-definition
public void CollapseRow(IGroup group)

Parameters

group

IGroup

The group that will be collapsed.

ExpandColumn(IGroup)

Expand an IGroup in the column area.

Declaration

cs-api-definition
public void ExpandColumn(IGroup group)

Parameters

group

IGroup

The group that will be expanded.

ExpandRow(IGroup)

Expand an IGroup in the row area.

Declaration

cs-api-definition
public void ExpandRow(IGroup group)

Parameters

group

IGroup

The group that will be expanded.

GenerateExport()

Generate export model that describe each cell in RadPivotGrid.

Declaration

cs-api-definition
public PivotExportModel GenerateExport()

Returns

PivotExportModel

The export model that describe each cell in RadPivotGrid.

GenerateExport(bool)

Generate export model that describe each cell in RadPivotGrid.

Declaration

cs-api-definition
public PivotExportModel GenerateExport(bool ignoreCollapsedGroups)

Parameters

ignoreCollapsedGroups

bool

Indicates whether to ignore collapsed groups when generating the 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.

Declaration

cs-api-definition
public bool IsColumnCollapsed(IGroup group)

Parameters

group

IGroup

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.

Declaration

cs-api-definition
public bool IsRowCollapsed(IGroup group)

Parameters

group

IGroup

The IGroup.

Returns

bool

true if the IGroup is collapsed; otherwise, false.

OnAllowSelectionChanged(bool, bool)

Called when the AllowSelection of the control has changed.

Declaration

cs-api-definition
protected override void OnAllowSelectionChanged(bool newValue, bool oldValue)

Parameters

newValue

bool

The new value.

oldValue

bool

The old value.

Overrides TableBase.OnAllowSelectionChanged(bool, bool)

OnApplyTemplate()

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides TableBase.OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

OnInitialized(EventArgs)

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

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

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