Class

RadPivotGrid

Initializes a new instance of the RadPivotGrid class with default settings. Creates an empty pivot grid control that can be configured to display aggregated data from various data sources.

Declaration

public RadPivotGrid()

A collection of PropertyAggregateDescription which describes how the values in the cells are calculated (aggregated).

Declaration

[Browsable(true)]
public AggregateDescriptionsCollection AggregateDescriptions { get; }

Property Value

Gets or sets the depth of the Aggregates groups among the other groups when more than one aggregate is used.

Declaration

[Browsable(true)]
public int AggregatesLevel { get; set; }

Property Value

Gets or sets the axis of the Aggregates groups when more than one aggregate is used.

Declaration

[Browsable(true)]
public PivotAxis AggregatesPosition { get; set; }

Property Value

Gets or sets a value indicating whether the built-in context menu is enabled.

Declaration

public bool AllowContextMenu { get; set; }

Property Value

Gets or sets a value indicating whether the built-in screen tips are enabled.

Declaration

public bool AllowDefaultScreenTips { get; set; }

Property Value

Gets or sets a value indicating whether fields can be dragged and dropped between different areas of the pivot grid. When enabled, users can reorganize the pivot layout by moving fields between row, column, value and filter areas.

Declaration

[Browsable(true)]
public bool AllowFieldsDragDrop { get; set; }

Property Value

Gets or sets a value indicating whether Group Filtering is enabled.

Declaration

public bool AllowGroupFiltering { get; set; }

Property Value

Gets or sets a value indicating whether the user is able to resize columns.

Declaration

public bool AllowHorizontalResize { get; set; }

Property Value

Gets or sets a value indicating whether the user is able to select cells.

Declaration

public bool AllowSelection { get; set; }

Property Value

Gets or sets a value indicating whether the user is able to sort the group labels.

Declaration

public bool AllowSorting { get; set; }

Property Value

Gets or sets a value indicating whether the user is able to resize rows.

Declaration

public bool AllowVerticalResize { get; set; }

Property Value

Gets or sets a value indicating whether the created column groups should be initially expanded.

Declaration

public bool AutoExpandColumnHeaders { get; set; }

Property Value

Gets or sets a value indicating whether the newly created row groups should be initially expanded.

Declaration

public bool AutoExpandRowHeaders { get; set; }

Property Value

Gets or sets the chart data provider.

Declaration

[Browsable(true)]
public PivotGridChartDataProvider ChartDataProvider { get; set; }

Property Value

Gets or sets the position of the GrandTotal column in the Columns axis.

Declaration

[Browsable(true)]
public TotalsPos ColumnGrandTotalsPosition { get; set; }

Property Value

A collection of PropertyGroupDescriptionBase which is used for generating column groups.

Declaration

[Browsable(true)]
public ColumnGroupDescriptionCollection ColumnGroupDescriptions { get; }

Property Value

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

Declaration

[Browsable(false)]
public IItemExpandBehavior<ExpandBehaviorParameters> ColumnGroupsExpandBehavior { get; set; }

Property Value

Gets or sets the height of the column headers area.

Declaration

public int ColumnHeaderHeight { get; set; }

Property Value

Gets or sets the layout type of the column headers.

Declaration

[Browsable(true)]
public PivotLayout ColumnHeadersLayout { get; set; }

Property Value

Gets or sets the default column width for all columns.

Declaration

public int ColumnWidth { get; set; }

Property Value

Gets or sets the position of the SubTotal columns in the Columns axis.

Declaration

[Browsable(true)]
public TotalsPos ColumnsSubTotalsPosition { get; set; }

Property Value

Gets or sets the name of the list or table in the data source for which RadPivotGrid is displaying aggregated data.

Declaration

[Browsable(true)]
public string DataMember { get; set; }

Property Value

Gets or sets the IDataProvider that populates the pivot grid with data.

Declaration

[Browsable(false)]
public IDataProvider DataProvider { get; set; }

Property Value

Gets or sets the data source for which RadPivotGrid is displaying aggregated data.

Declaration

public object DataSource { get; set; }

Property Value

Gets the default size of the control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets or sets the dialogs factory.

Declaration

[Browsable(false)]
public PivotGridDialogsFactory DialogsFactory { get; set; }

Property Value

Gets or sets the string that will appears on cells that do not have a value.

Declaration

public string EmptyValueString { get; set; }

Property Value

Gets or sets the string that will appears on cells for which an error has occured during calculation.

Declaration

public string ErrorString { get; set; }

Property Value

Gets or sets the height of the report filters area.

Declaration

public int FilterAreaHeight { get; set; }

Property Value

A collection of PropertyFilterDescription which defines the fields that are available in the Report Filters area.

Declaration

[Browsable(true)]
public FilterDescriptionsCollection FilterDescriptions { get; }

Property Value

Gets the pivot grid element.

Declaration

[Browsable(false)]
public RadPivotGridElement PivotGridElement { get; }

Property Value

Gets or sets the PivotGridPrintStyle that is responsible for printing the pivot grid.

Declaration

[Browsable(true)]
public PivotGridPrintStyle PrintStyle { get; set; }

Property Value

Gets or sets the position of the GrandTotal row in the Rows axis.

Declaration

[Browsable(true)]
public TotalsPos RowGrandTotalsPosition { get; set; }

Property Value

A collection of PropertyGroupDescriptionBase which is used for generating row groups.

Declaration

[Browsable(true)]
public RowGroupDescriptionCollection RowGroupDescriptions { get; }

Property Value

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

Declaration

[Browsable(false)]
public IItemExpandBehavior<ExpandBehaviorParameters> RowGroupsExpandBehavior { get; set; }

Property Value

Gets or sets the layout type of the row headers.

Declaration

[Browsable(true)]
public PivotLayout RowHeadersLayout { get; set; }

Property Value

Gets or sets the default row height for all rows.

Declaration

public int RowHeight { get; set; }

Property Value

Gets or sets the position of the SubTotal rows in the Rows axis.

Declaration

[Browsable(true)]
public TotalsPos RowsSubTotalsPosition { get; set; }

Property Value

Gets or sets a value indicating whether the Report Filters area should be displayed.

Declaration

[Browsable(true)]
public bool ShowFilterArea { get; set; }

Property Value

Gets or sets the serialization information for RadPivotGrid used by SaveLayout and LoadLayout methods to persist and restore grid settings. By default or when set to null, the ComponentXmlSerializationInfo provided by GetDefaultXmlSerializationInfo() will be used.

Declaration

[Browsable(false)]
public ComponentXmlSerializationInfo XmlSerializationInfo { get; set; }

Property Value

Signals the start of the control's initialization and suspends layout and data updates. Used during control creation and when loading the control state from a serialized form.

Declaration

public override void BeginInit()

Overrides RadControl.BeginInit()

Puts RadPivotGrid in update mode and suspends visual refreshing. Use this method before making multiple property changes to improve performance by preventing multiple layout updates. Must be paired with a subsequent call to EndUpdate() when finished making changes.

Declaration

public void BeginUpdate()

Creates the child elements for the RadPivotGrid control. Initializes the pivotGridElement and adds it to the parent's collection.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates the RadPivotGridElement which is the main visual element of the pivot grid control. Override this method to create a custom pivot grid element when inheriting from RadPivotGrid.

Declaration

protected virtual RadPivotGridElement CreatePivotGridElement()

Returns

Creates the XML serializer used for saving and loading the pivot grid's layout. Override this method to provide custom serialization behavior when extending this control.

Declaration

protected virtual ComponentXmlSerializer CreateXmlSerializer(ComponentXmlSerializationInfo info)

Parameters

Returns

Signals the end of the control's initialization and resumes layout and data updates. The control will be refreshed to reflect all changes made during initialization.

Declaration

public override void EndInit()

Overrides RadControl.EndInit()

Ends the update mode and refreshes the pivot grid's visual representation. Call this method after BeginUpdate() once you've finished making property changes to apply all pending updates at once.

Declaration

public void EndUpdate()

Gets the default serialization information for RadPivotGrid used by SaveLayout and LoadLayout methods to persist and restore grid settings to/from XML. This includes configuration of rows, columns, aggregates, filters, and appearance settings.

Declaration

protected virtual ComponentXmlSerializationInfo GetDefaultXmlSerializationInfo()

Returns

Determines whether the specified key is a regular input key or a special key that requires preprocessing.

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Returns

Overrides RadControl.IsInputKey(Keys)

Loads the RadPivotGrid's layout configuration from an XML stream. Restores group configurations, column widths, row heights, and other display settings from the provided stream.

Declaration

public virtual void LoadLayout(Stream stream)

Parameters

Loads the RadPivotGrid's layout configuration from an XML reader. Restores group configurations, column widths, row heights, and other display settings from the provided XML reader.

Declaration

public virtual void LoadLayout(XmlReader xmlReader)

Parameters

Loads the RadPivotGrid's layout configuration from an XML file. Restores group configurations, column widths, row heights, and other display settings from the specified file.

Declaration

public virtual void LoadLayout(string fileName)

Parameters

Raises the KeyDown event.

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Overrides RadControl.OnKeyDown(KeyEventArgs)

Raises the LostFocus event.

Declaration

protected override void OnLostFocus(EventArgs e)

Parameters

Overrides RadControl.OnLostFocus(EventArgs)

Raises the MouseDown event.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseDown(MouseEventArgs)

Raises the MouseMove event.

Declaration

protected override void OnMouseMove(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseMove(MouseEventArgs)

Raises the event.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseUp(MouseEventArgs)

Raises the MouseWheel event.

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Overrides RadControl.OnMouseWheel(MouseEventArgs)

Called when the screen tip is needed.

Declaration

protected override void OnScreenTipNeeded(object sender, ScreenTipNeededEventArgs e)

Parameters

Overrides RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)

Directly prints the RadPivotGrid to the default printer without showing any printer settings dialog. This is a convenience method that uses the current default printer with default settings.

Declaration

public virtual void Print()

Prints the RadPivotGrid with an option to display the printer settings dialog first.

Declaration

public virtual void Print(bool showPrinterSettings)

Parameters

Prints the RadPivotGrid using a specified print document and with an option to display the printer settings dialog.

Declaration

public virtual void Print(bool showPrinterSettings, RadPrintDocument document)

Parameters

Opens a print preview dialog that allows viewing and adjusting how the pivot grid will appear when printed. This method creates a new RadPrintDocument with default settings.

Declaration

public virtual void PrintPreview()

Opens a print preview dialog that allows viewing and adjusting how the pivot grid will appear when printed. This overload uses a specified RadPrintDocument for more control over the printing process.

Declaration

public virtual void PrintPreview(RadPrintDocument document)

Parameters

Recalculates all the aggregated data and refreshes the visual representation of the pivot grid. Use this method when the underlying data source has changed and you need to update the pivot grid.

Declaration

public void ReloadData()

Saves the RadPivotGrid's current layout configuration to a stream in XML format. This includes group configurations, column widths, row heights, and other display settings. The stream remains open after the operation completes.

Declaration

public virtual void SaveLayout(Stream stream)

Parameters

Saves the RadPivotGrid's current layout configuration to XML format. This includes properties like group configurations, column widths, row heights, and other display settings.

Declaration

public virtual void SaveLayout(XmlWriter xmlWriter)

Parameters

Saves the RadPivotGrid's current layout configuration to a file in XML format. This includes group configurations, column widths, row heights, and other display settings.

Declaration

public virtual void SaveLayout(string fileName)

Parameters

Shows the Field Chooser dialog which allows users to select and organize fields in the pivot grid. Users can drag fields to different areas (row fields, column fields, data fields, or filter fields) to reorganize the pivot grid.

Declaration

public void ShowFieldList()

Fires when an aggregate descriptor element is being created. Allows for replacing it with a custom element.

Declaration

public event AggregateDescriptorElementCreatingEventHandler AggregateDescriptorElementCreating

Event Value

Fires when the aggregate position element is being created. Allows for replacing it with a custom element.

Declaration

public event AggregatesPositionElementCreatingEventHandler AggregatesPositionElementCreating

Event Value

Fires when a cell element is being created. Allows for replacing the default elements with custom ones.

Declaration

public event PivotCellCreatingEventHandler CellCreating

Event Value

Fires when a cell element is updated. Allows for customizing the appearance of the cells.

Declaration

public event PivotCellEventHandler CellFormatting

Event Value

Fires when the DataProvider property has changed.

Declaration

public event DataProviderChangedEventHandler DataProviderChanged

Event Value

Fires when a filter descriptor element is being created. Allows for replacing it with a custom element.

Declaration

public event FilterDescriptorElementCreatingEventHandler FilterDescriptorElementCreating

Event Value

Fires when a group descriptor element is being created. Allows for replacing it with a custom element.

Declaration

public event GroupDescriptorElementCreatingEventHandler GroupDescriptorElementCreating

Event Value

Fires when a group element is being created. Allows for replacing the default group elements.

Declaration

public event PivotGroupElementCreatingEventHandler GroupElementCreating

Event Value

Fires when a group element is updated. Allows for customizing its appearance.

Declaration

public event PivotGroupElementEventHandler GroupElementFormatting

Event Value

Fires when a group is expanded or collapsed.

Declaration

public event PivotGroupEventHandler GroupExpandedChanged

Event Value

Fires when a print element is being prepared for painting.

Declaration

public event PrintElementEventHandler PrintElementFormatting

Event Value

Fires when the print element has been painted. Allows for adding custom painting.

Declaration

public event PrintElementPaintEventHandler PrintElementPaint

Event Value

Fires when a row element is being created. Allows for replacing the default elements with custom ones.

Declaration

public event PivotRowCreatingEventHandler RowCreating

Event Value

Fires when a row element is updated.

Declaration

public event PivotRowEventHandler RowFormatting

Event Value

Fires when the selection in RadPivotGrid has changed.

Declaration

public event EventHandler SelectionChanged

Event Value

Fires when the data provider has finished building the data and the UI was updated.

Declaration

public event EventHandler UpdateCompleted

Event Value