Documentation

Class RadPivotGrid

Represents a control that displays data in a customizable pivot.

Inheritance
System.Object
TableBase
RadPivotGrid
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Pivot.dll

Syntax

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

Constructors

RadPivotGrid()

Initializes a new instance of the RadPivotGrid class.

Declaration
public RadPivotGrid()

Fields

CanUserResizeColumnsProperty

The DependencyProperty that represents the CanUserResizeColumns property.

Declaration
public static readonly DependencyProperty CanUserResizeColumnsProperty
Field Value
System.Windows.DependencyProperty

ColumnGroupsExpandBehaviorProperty

Identifies the ColumnGroupsExpandBehavior dependency property.

Declaration
public static readonly DependencyProperty ColumnGroupsExpandBehaviorProperty
Field Value
System.Windows.DependencyProperty

DataProviderProperty

Identifies the DataProvider dependency property.

Declaration
public static readonly DependencyProperty DataProviderProperty
Field Value
System.Windows.DependencyProperty

EmptyValueTextProperty

Identifies the EmptyValueText dependency property.

Declaration
public static readonly DependencyProperty EmptyValueTextProperty
Field Value
System.Windows.DependencyProperty

ErrorValueTextProperty

Identifies the ErrorValueText dependency property.

Declaration
public static readonly DependencyProperty ErrorValueTextProperty
Field Value
System.Windows.DependencyProperty

IsBusyProperty

Identifies the IsBusy read-only dependency property.

Declaration
public static readonly DependencyProperty IsBusyProperty
Field Value
System.Windows.DependencyProperty

MaximumResizeWidthProperty

The DependencyProperty that represents the MaximumResizeWidth property.

Declaration
public static readonly DependencyProperty MaximumResizeWidthProperty
Field Value
System.Windows.DependencyProperty

MinimumResizeWidthProperty

The DependencyProperty that represents the MinimumResizeWidth property.

Declaration
public static readonly DependencyProperty MinimumResizeWidthProperty
Field Value
System.Windows.DependencyProperty

RowGroupsExpandBehaviorProperty

Identifies the RowGroupsExpandBehavior dependency property.

Declaration
public static readonly DependencyProperty RowGroupsExpandBehaviorProperty
Field Value
System.Windows.DependencyProperty

ShowAggregateValuesInlineProperty

Identifies the ShowAggregateValuesInline dependency property.

Declaration
public static readonly DependencyProperty ShowAggregateValuesInlineProperty
Field Value
System.Windows.DependencyProperty

Properties

CanUserResizeColumns

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

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

ColumnGroups

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

Declaration
public IReadOnlyList<IGroup> ColumnGroups { get; }
Property Value
System.Collections.Generic.IReadOnlyList<IGroup>

ColumnGroupsExpandBehavior

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

Declaration
public IItemExpandBehavior<ExpandBehaviorParameters> ColumnGroupsExpandBehavior { get; set; }
Property Value
IItemExpandBehavior<ExpandBehaviorParameters>

ColumnLevels

Gets the depth of the columns.

Declaration
public int ColumnLevels { get; }
Property Value
System.Int32

DataProvider

Gets or sets the data provider.

Declaration
public IDataProvider DataProvider { get; set; }
Property Value
IDataProvider

EmptyValueText

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

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

ErrorValueText

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

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

IsBusy

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

Declaration
public bool IsBusy { get; }
Property Value
System.Boolean

MaximumResizeWidth

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

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

MinimumResizeWidth

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

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

RowGroups

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

Declaration
public IReadOnlyList<IGroup> RowGroups { get; }
Property Value
System.Collections.Generic.IReadOnlyList<IGroup>

RowGroupsExpandBehavior

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

Declaration
public IItemExpandBehavior<ExpandBehaviorParameters> RowGroupsExpandBehavior { get; set; }
Property Value
IItemExpandBehavior<ExpandBehaviorParameters>

RowLevels

Gets the depth of the rows.

Declaration
public int RowLevels { get; }
Property Value
System.Int32

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
public bool ShowAggregateValuesInline { get; set; }
Property Value
System.Boolean

Methods

CollapseColumn(IGroup)

Collapse an IGroup in the column area.

Declaration
public void CollapseColumn(IGroup group)
Parameters
IGroup group

The group that will be collapsed.

CollapseRow(IGroup)

Collapse an IGroup in the row area.

Declaration
public void CollapseRow(IGroup group)
Parameters
IGroup group

The group that will be collapsed.

ExpandColumn(IGroup)

Expand an IGroup in the column area.

Declaration
public void ExpandColumn(IGroup group)
Parameters
IGroup group

The group that will be expanded.

ExpandRow(IGroup)

Expand an IGroup in the row area.

Declaration
public void ExpandRow(IGroup group)
Parameters
IGroup group

The group that will be expanded.

GenerateExport()

Generate export model that describe each cell in RadPivotGrid.

Declaration
public PivotExportModel GenerateExport()
Returns
PivotExportModel

The export model that describe each cell in RadPivotGrid.

GenerateExport(Boolean)

Generate export model that describe each cell in RadPivotGrid.

Declaration
public PivotExportModel GenerateExport(bool ignoreCollapsedGroups)
Parameters
System.Boolean ignoreCollapsedGroups

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
public bool IsColumnCollapsed(IGroup group)
Parameters
IGroup group

The IGroup.
Returns
System.Boolean

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
public bool IsRowCollapsed(IGroup group)
Parameters
IGroup group

The IGroup.
Returns
System.Boolean

true if the IGroup is collapsed; otherwise, false.

OnAllowSelectionChanged(Boolean, Boolean)

Called when the AllowSelection of the control has changed.

Declaration
protected override void OnAllowSelectionChanged(bool newValue, bool oldValue)
Parameters
System.Boolean newValue

The new value.
System.Boolean oldValue

The old value.
Overrides

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

Extension Methods