Class RadPivotGridElement

Represents the main element in RadPivotGrid

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadPivotGridElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

public class RadPivotGridElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IPrintable, IChartDataProvider

Constructors

RadPivotGridElement()

Initializes a new instance of the RadPivotGridElement class. Sets up the basic structure, initializes collections for row groups, column groups, aggregates, and filters, and configures the pivot grid's visualization model.

Declaration
public RadPivotGridElement()

Fields

ColumnHeaderHeightProperty

Declaration
public static RadProperty ColumnHeaderHeightProperty
Field Value
RadProperty

ColumnWidthProperty

Declaration
public static RadProperty ColumnWidthProperty
Field Value
RadProperty

DefaultColumnHeaderHeight

Declaration
public const int DefaultColumnHeaderHeight = 30
Field Value
System.Int32

DefaultColumnWidth

Declaration
public const int DefaultColumnWidth = 100
Field Value
System.Int32

DefaultFilterAreaHeight

Declaration
public const int DefaultFilterAreaHeight = 30
Field Value
System.Int32

DefaultRowHeight

Declaration
public const int DefaultRowHeight = 25
Field Value
System.Int32

DragHintProperty

Declaration
public static RadProperty DragHintProperty
Field Value
RadProperty

FilterAreaHeightProperty

Declaration
public static RadProperty FilterAreaHeightProperty
Field Value
RadProperty

RowHeightProperty

Declaration
public static RadProperty RowHeightProperty
Field Value
RadProperty

Properties

AggregateDescriptions

Gets the collection of aggregate descriptions that define the calculation operations applied to data cells. These descriptions determine which aggregation functions (sum, count, average, etc.) are used for data analysis.

Declaration
public AggregateDescriptionsCollection AggregateDescriptions { get; }
Property Value
AggregateDescriptionsCollection

AggregateDescriptorsArea

Gets the aggregate descriptors area.

Declaration
public PivotAggregateDescriptorContainer AggregateDescriptorsArea { get; }
Property Value
PivotAggregateDescriptorContainer

The aggregate descriptors area.

AggregatesLevel

Gets or sets the aggregates level.

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

The aggregates level.

AggregatesPosition

Gets or sets the aggregates position.

Declaration
public PivotAxis AggregatesPosition { get; set; }
Property Value
PivotAxis

The aggregates position.

AllowContextMenu

Gets or sets whether to allow context menu.

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

The allow context menu.

AllowDefaultScreenTips

Gets or sets whether the default screen tips are allowed.

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

The allow default screen tips.

AllowFieldsDragDrop

Gets or sets whether the fields drag drop is allowed.

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

The allow fields drag drop.

AllowGroupFiltering

Gets or sets whether the group filtering is allowed.

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

The allow group filtering.

AllowHorizontalResize

Gets or sets whether the horizontal resize is allowed.

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

The allow horizontal resize.

AllowSelection

Gets or sets whether the selection is allowed.

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

The allow selection.

AllowSorting

Determines whether the sorting is allowed.

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

The allow sorting.

AllowVerticalResize

Determines whether the vertical resize is allowed.

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

The allow vertical resize.

AutoExpandColumnHeaders

Gets or sets the auto expand column headers.

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

The auto expand column headers.

AutoExpandRowHeaders

Gets or sets the auto expand row headers.

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

The auto expand row headers.

BestFitHelper

Gets or sets the best fit helper.

Declaration
public PivotBestFitHelper BestFitHelper { get; set; }
Property Value
PivotBestFitHelper

The best fit helper.

ChartDataProvider

Gets or sets the chart data provider.

Declaration
public PivotGridChartDataProvider ChartDataProvider { get; set; }
Property Value
PivotGridChartDataProvider

The chart data provider.

ColumnDescriptorsArea

Gets the column descriptors area.

Declaration
public PivotColumnDescriptorContainer ColumnDescriptorsArea { get; }
Property Value
PivotColumnDescriptorContainer

The column descriptors area.

ColumnGrandTotalsPosition

Gets or sets the column grand totals position.

Declaration
public TotalsPos ColumnGrandTotalsPosition { get; set; }
Property Value
TotalsPos

The column grand totals position.

ColumnGroupDescriptions

Gets the collection of column group descriptions used for organizing data into column hierarchies. Column group descriptions determine how data is grouped and displayed across columns in the pivot grid.

Declaration
public ColumnGroupDescriptionCollection ColumnGroupDescriptions { get; }
Property Value
ColumnGroupDescriptionCollection

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>

ColumnHeaderContainer

Gets the column header container.

Declaration
public PivotHeaderVirtualizedContainer ColumnHeaderContainer { get; }
Property Value
PivotHeaderVirtualizedContainer

The column header container.

ColumnHeaderHeight

Gets or sets the height of the column header.

Declaration
[VsbBrowsable(true)]
public int ColumnHeaderHeight { get; set; }
Property Value
System.Int32

The height of the column header.

ColumnHeadersLayout

Gets or sets the column headers layout.

Declaration
public PivotLayout ColumnHeadersLayout { get; set; }
Property Value
PivotLayout

The column headers layout.

ColumnRootGroup

Gets the column root group.

Declaration
public PivotGroupNode ColumnRootGroup { get; }
Property Value
PivotGroupNode

The column root group.

ColumnScroller

Gets the column scroller.

Declaration
public ItemScroller<PivotGroupNode> ColumnScroller { get; }
Property Value
ItemScroller<PivotGroupNode>

The column scroller.

ColumnsSubTotalsPosition

Gets or sets the columns sub totals position.

Declaration
public TotalsPos ColumnsSubTotalsPosition { get; set; }
Property Value
TotalsPos

The columns sub totals position.

ColumnWidth

Gets or sets the width of the column.

Declaration
[VsbBrowsable(true)]
public int ColumnWidth { get; set; }
Property Value
System.Int32

The width of the column.

ContextMenu

Gets or sets the context menu.

Declaration
public PivotGridContextMenuBase ContextMenu { get; set; }
Property Value
PivotGridContextMenuBase

The context menu.

DataMember

Gets or sets the data member.

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

The data member.

DataProvider

Gets or sets the data provider.

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

The data provider.

DataSource

Gets or sets the data source for the pivot grid. This is the source collection of data items that will be analyzed and aggregated according to the defined pivot grid settings.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

DialogsFactory

Gets or sets the dialogs factory.

Declaration
public PivotGridDialogsFactory DialogsFactory { get; set; }
Property Value
PivotGridDialogsFactory

The dialogs factory.

DragDropService

Gets or sets the drag drop service.

Declaration
public PivotGridDragDropService DragDropService { get; set; }
Property Value
PivotGridDragDropService

The drag drop service.

DragHint

Gets or sets the drag hint.

Declaration
[VsbBrowsable(true)]
public RadImageShape DragHint { get; set; }
Property Value
RadImageShape

The drag hint.

EmptyValueString

Gets or sets the empty value string.

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

The empty value string.

ErrorString

Gets or sets the error string.

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

The error string.

FilterAreaHeight

Gets or sets the height of the filter area.

Declaration
[VsbBrowsable(true)]
public int FilterAreaHeight { get; set; }
Property Value
System.Int32

The height of the filter area.

FilterDescriptions

Gets the filter descriptions.

Declaration
public FilterDescriptionsCollection FilterDescriptions { get; }
Property Value
FilterDescriptionsCollection

The filter descriptions.

FilterDescriptorsArea

Gets the filter descriptors area.

Declaration
public PivotFilterDescriptorContainer FilterDescriptorsArea { get; }
Property Value
PivotFilterDescriptorContainer

The filter descriptors area.

HScrollBar

Gets the horizontal scroll bar.

Declaration
public RadScrollBarElement HScrollBar { get; }
Property Value
RadScrollBarElement

The H scroll bar.

IsBusy

Gets or sets whether the pivot element is busy.

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

The is busy.

LayoutState

Gets or sets an object which holds the state of the resized and the collapsed rows and columns. Setting the object will apply the state and will update the layout.

Declaration
public PivotLayoutState LayoutState { get; set; }
Property Value
PivotLayoutState

PivotRowsContainer

Gets the pivot rows container.

Declaration
public PivotVirtualizedStackContainer PivotRowsContainer { get; }
Property Value
PivotVirtualizedStackContainer

The pivot rows container.

PrintStyle

Gets or sets the print style.

Declaration
public PivotGridPrintStyle PrintStyle { get; set; }
Property Value
PivotGridPrintStyle

The print style.

ResizingBehavior

Gets or sets the resizing behavior.

Declaration
public ResizingBehavior ResizingBehavior { get; set; }
Property Value
ResizingBehavior

The resizing behavior.

RowDescriptorsArea

Gets the row descriptors area.

Declaration
public PivotRowDescriptorContainer RowDescriptorsArea { get; }
Property Value
PivotRowDescriptorContainer

The row descriptors area.

RowGrandTotalsPosition

Gets or sets the row grand totals position.

Declaration
public TotalsPos RowGrandTotalsPosition { get; set; }
Property Value
TotalsPos

The row grand totals position.

RowGroupDescriptions

Gets the collection of row group descriptions used for organizing data into row hierarchies. Row group descriptions determine how data is grouped and displayed in the rows of the pivot grid.

Declaration
public RowGroupDescriptionCollection RowGroupDescriptions { get; }
Property Value
RowGroupDescriptionCollection

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>

RowHeaderContainer

Gets the row header container.

Declaration
public PivotHeaderVirtualizedContainer RowHeaderContainer { get; }
Property Value
PivotHeaderVirtualizedContainer

The row header container.

RowHeadersLayout

Gets or sets the row headers layout.

Declaration
public PivotLayout RowHeadersLayout { get; set; }
Property Value
PivotLayout

The row headers layout.

RowHeight

Gets or sets the height of the row.

Declaration
[VsbBrowsable(true)]
public int RowHeight { get; set; }
Property Value
System.Int32

The height of the row.

RowRootGroup

Gets the row root group.

Declaration
public PivotGroupNode RowRootGroup { get; }
Property Value
PivotGroupNode

The row root group.

RowScroller

Gets the row scroller.

Declaration
public ItemScroller<PivotGroupNode> RowScroller { get; }
Property Value
ItemScroller<PivotGroupNode>

The row scroller.

RowsSubTotalsPosition

Gets or sets the rows sub totals position.

Declaration
public TotalsPos RowsSubTotalsPosition { get; set; }
Property Value
TotalsPos

The rows sub totals position.

ShowFilterArea

Gets or sets whether to show the filter area.

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

The show filter area.

VScrollBar

Gets the V scroll bar.

Declaration
public RadScrollBarElement VScrollBar { get; }
Property Value
RadScrollBarElement

The V scroll bar.

WaitingBar

Gets the waiting bar.

Declaration
public RadWaitingBarElement WaitingBar { get; }
Property Value
RadWaitingBarElement

The waiting bar.

Methods

ArrangeOverride(SizeF)

Arranges the element in the final size.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

Overrides

BeginUpdate()

Begins the update operation.

Declaration
public void BeginUpdate()

ClearSelection()

Clears all cell selections in the pivot grid.

Declaration
public void ClearSelection()

ColumnContainsSelection(PivotGroupNode)

Returns whether the column contains selection.

Declaration
public bool ColumnContainsSelection(PivotGroupNode column)
Parameters
PivotGroupNode column

The column.
Returns
System.Boolean

CopySelectionToClipboard()

Copies the selection to clipboard.

Declaration
public void CopySelectionToClipboard()

CopyToClipboard(PivotGroupNode, PivotGroupNode, PivotGroupNode, PivotGroupNode)

Copies to clipboard.

Declaration
public void CopyToClipboard(PivotGroupNode startRow, PivotGroupNode startColumn, PivotGroupNode endRow, PivotGroupNode endColumn)
Parameters
PivotGroupNode startRow

The start row.
PivotGroupNode startColumn

The start column.
PivotGroupNode endRow

The end row.
PivotGroupNode endColumn

The end column.

CopyToClipboard(PivotGroupNode, PivotGroupNode, PivotGroupNode, PivotGroupNode, Boolean)

Copies to clipboard.

Declaration
public void CopyToClipboard(PivotGroupNode startRow, PivotGroupNode startColumn, PivotGroupNode endRow, PivotGroupNode endColumn, bool selectedOnly)
Parameters
PivotGroupNode startRow

The start row.
PivotGroupNode startColumn

The start column.
PivotGroupNode endRow

The end row.
PivotGroupNode endColumn

The end column.
System.Boolean selectedOnly

Indicates whether the selection only will be processed.

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

DataBind()

Binds the data using the current DataSource property value. Processes the data source and creates the pivot structure based on the current group, filter, and aggregate settings.

Declaration
public void DataBind()

DeferRefresh()

Defers the refresh.

Declaration
public IDisposable DeferRefresh()
Returns
System.IDisposable

DisposeManagedResources()

Disposes the managed resources.

Declaration
protected override void DisposeManagedResources()
Overrides

DpiScaleChanged(SizeF)

Occurs when the DPI scale is changed.

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

The scale factor.
Overrides

EndUpdate()

Ends the update operation.

Declaration
public void EndUpdate()

GetAggregateValue(IGroup, IGroup, Boolean, Boolean)

Gets the aggregate value.

Declaration
public CellAggregateValue GetAggregateValue(IGroup row, IGroup column, bool collapsedRow, bool collapsedColumn)
Parameters
IGroup row

The row.
IGroup column

The column.
System.Boolean collapsedRow

The collapsed row.
System.Boolean collapsedColumn

The collapsed column.
Returns
CellAggregateValue

GetCellElement(PivotGroupNode, PivotGroupNode)

Gets the cell element.

Declaration
public PivotCellElement GetCellElement(PivotGroupNode row, PivotGroupNode column)
Parameters
PivotGroupNode row

The row.
PivotGroupNode column

The column.
Returns
PivotCellElement

GetColumnGroups()

Gets the column groups.

Declaration
public IEnumerable<PivotGroupNode> GetColumnGroups()
Returns
System.Collections.Generic.IEnumerable<PivotGroupNode>

GetGroupElement(PivotGroupNode)

Gets the group element.

Declaration
public PivotGroupElement GetGroupElement(PivotGroupNode node)
Parameters
PivotGroupNode node

The node.
Returns
PivotGroupElement

GetGroupNodeSize(PivotGroupNode)

Gets the size of the group node.

Declaration
public int GetGroupNodeSize(PivotGroupNode node)
Parameters
PivotGroupNode node

The node.
Returns
System.Int32

GetRowElement(PivotGroupNode)

Gets the row element.

Declaration
public PivotRowElement GetRowElement(PivotGroupNode row)
Parameters
PivotGroupNode row

The row.
Returns
PivotRowElement

GetRowGroups()

Gets the row groups.

Declaration
public IEnumerable<PivotGroupNode> GetRowGroups()
Returns
System.Collections.Generic.IEnumerable<PivotGroupNode>

GetRowHeaderWidth(Int32)

Gets the width of the row header.

Declaration
public int GetRowHeaderWidth(int level)
Parameters
System.Int32 level

The level.
Returns
System.Int32

GetRowHeaderWidth(Int32, Int32)

Gets the width of the row header.

Declaration
public int GetRowHeaderWidth(int level, int span)
Parameters
System.Int32 level

The level.
System.Int32 span

The span.
Returns
System.Int32

IsCellSelected(PivotGroupNode, PivotGroupNode)

Determines whether the cell is selected.

Declaration
public bool IsCellSelected(PivotGroupNode row, PivotGroupNode column)
Parameters
PivotGroupNode row

The row.
PivotGroupNode column

The column.
Returns
System.Boolean

IsInResizeLocation(Point)

Determines whether the point is in resize location.

Declaration
protected virtual bool IsInResizeLocation(Point p)
Parameters
System.Drawing.Point p

The p.
Returns
System.Boolean

MeasureOverride(SizeF)

Measures the element with the available size.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size.
Returns
System.Drawing.SizeF

Overrides

OnAggregateDescriptionElementCreating(PivotAggregateDescriptorElement)

Called when the aggregate description element is being created.

Declaration
protected virtual PivotAggregateDescriptorElement OnAggregateDescriptionElementCreating(PivotAggregateDescriptorElement element)
Parameters
PivotAggregateDescriptorElement element

The element.
Returns
PivotAggregateDescriptorElement

OnAggregatesPositionElementCreating(AggregatesPositionDescriptorElement)

Called when the aggregates position element is being created.

Declaration
protected virtual AggregatesPositionDescriptorElement OnAggregatesPositionElementCreating(AggregatesPositionDescriptorElement element)
Parameters
AggregatesPositionDescriptorElement element

The element.
Returns
AggregatesPositionDescriptorElement

OnCellCreating(PivotCellCreatingEventArgs)

Raises the CellCreating event.

Declaration
protected virtual void OnCellCreating(PivotCellCreatingEventArgs args)
Parameters
PivotCellCreatingEventArgs args

The PivotCellCreatingEventArgs instance containing the event data.

OnCellFormatting(PivotCellElement)

Called when the cell is being formatted.

Declaration
protected virtual void OnCellFormatting(PivotCellElement cell)
Parameters
PivotCellElement cell

The cell.

OnDataProviderChanged(IDataProvider, IDataProvider)

Called when the data provider is changed.

Declaration
protected virtual void OnDataProviderChanged(IDataProvider newProvider, IDataProvider oldProvider)
Parameters
IDataProvider newProvider

The new provider.
IDataProvider oldProvider

The old provider.

OnFieldChooserShowing(FieldChooserShowingEventArgs)

Raises the FieldChooserShowing event.

Declaration
protected virtual void OnFieldChooserShowing(FieldChooserShowingEventArgs args)
Parameters
FieldChooserShowingEventArgs args

The FieldChooserShowingEventArgs instance containing the event data.

OnFilterDescriptionElementCreating(PivotFilterDescriptorElement)

Called when the filter description element is being created.

Declaration
protected virtual PivotFilterDescriptorElement OnFilterDescriptionElementCreating(PivotFilterDescriptorElement element)
Parameters
PivotFilterDescriptorElement element

The element.
Returns
PivotFilterDescriptorElement

OnGroupDescriptionElementCreating(PivotGroupDescriptorElement, PivotAxis)

Called when the group description element is being created.

Declaration
protected virtual PivotGroupDescriptorElement OnGroupDescriptionElementCreating(PivotGroupDescriptorElement element, PivotAxis axis)
Parameters
PivotGroupDescriptorElement element

The element.
PivotAxis axis

The axis.
Returns
PivotGroupDescriptorElement

OnGroupElementCreating(PivotGroupElementCreatingEventArgs)

Raises the GroupElementCreating event.

Declaration
protected virtual void OnGroupElementCreating(PivotGroupElementCreatingEventArgs args)
Parameters
PivotGroupElementCreatingEventArgs args

The PivotGroupElementCreatingEventArgs instance containing the event data.

OnGroupElementFormatting(PivotGroupElementEventArgs)

Raises the GroupElementFormatting event.

Declaration
protected virtual void OnGroupElementFormatting(PivotGroupElementEventArgs args)
Parameters
PivotGroupElementEventArgs args

The PivotGroupElementEventArgs instance containing the event data.

OnGroupExpandedChanged(PivotGroupEventArgs)

Raises the GroupExpandedChanged event.

Declaration
protected virtual void OnGroupExpandedChanged(PivotGroupEventArgs args)
Parameters
PivotGroupEventArgs args

The PivotGroupEventArgs instance containing the event data.

OnPrintElementFormatting(RadPrintElement)

Called when the print element is being formatted.

Declaration
protected virtual void OnPrintElementFormatting(RadPrintElement printElement)
Parameters
RadPrintElement printElement

The print element.

OnPrintElementPaint(RadPrintElement, Graphics, Rectangle)

Called when the print element is painted.

Declaration
protected virtual void OnPrintElementPaint(RadPrintElement printElement, Graphics g, Rectangle bounds)
Parameters
RadPrintElement printElement

The print element.
System.Drawing.Graphics g

The g.
System.Drawing.Rectangle bounds

The bounds.

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnRowCreating(PivotRowCreatingEventArgs)

Raises the RowCreating event.

Declaration
protected virtual void OnRowCreating(PivotRowCreatingEventArgs args)
Parameters
PivotRowCreatingEventArgs args

The PivotRowCreatingEventArgs instance containing the event data.

OnRowFormatting(PivotRowElement)

Called when the row is being formatting.

Declaration
protected virtual void OnRowFormatting(PivotRowElement row)
Parameters
PivotRowElement row

The row.

OnSelectionChanged()

Called when the selection is changed.

Declaration
protected virtual void OnSelectionChanged()

OnUpdateCompleted()

Called when the update is completed.

Declaration
protected virtual void OnUpdateCompleted()

Print()

Directly prints the RadPivotGrid to the default printer.

Declaration
public virtual void Print()

Print(Boolean)

Directly prints the RadPivotGrid to the default printer or shows printer settitngs and then prints the RadPivotGrid.

Declaration
public virtual void Print(bool showPrinterSettings)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.

Print(Boolean, RadPrintDocument)

Directly prints the RadPivotGrid to the default printer or shows printer settitngs and then prints the RadPivotGrid.

Declaration
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Parameters
System.Boolean showPrinterSettings

Indicates whether printer settings dialog should be shown.
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

PrintPreview()

Shows a RadPrintPreviewDialog for editing the RadPivotGrid print settings.

Declaration
public virtual void PrintPreview()

PrintPreview(RadPrintDocument)

Shows a RadPrintPreviewDialog for editing the RadPivotGrid print settings.

Declaration
public virtual void PrintPreview(RadPrintDocument document)
Parameters
RadPrintDocument document

As instance of RadPrintDocument used to control the print process.

ProcessGroupPropertyChanged(PivotGroupNode, String)

Declaration
public void ProcessGroupPropertyChanged(PivotGroupNode groupNode, string propertyName)
Parameters
PivotGroupNode groupNode

System.String propertyName

ProcessKeyDown(KeyEventArgs)

Processes the key down.

Declaration
public virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseDown(MouseEventArgs)

Processes the mouse down.

Declaration
public virtual bool ProcessMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseMove(MouseEventArgs)

Processes the mouse move.

Declaration
public virtual bool ProcessMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseUp(MouseEventArgs)

Processes the mouse up.

Declaration
public virtual bool ProcessMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseWheel(MouseEventArgs)

Processes the mouse wheel.

Declaration
public virtual bool ProcessMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessScreenTip(ScreenTipNeededEventArgs)

Processes the screen tip.

Declaration
public virtual bool ProcessScreenTip(ScreenTipNeededEventArgs e)
Parameters
ScreenTipNeededEventArgs e

The ScreenTipNeededEventArgs instance containing the event data.
Returns
System.Boolean

RefreshData()

Refreshes the data.

Declaration
public void RefreshData()

RowContainsSelection(PivotGroupNode)

Returns whether the row contains selection.

Declaration
public bool RowContainsSelection(PivotGroupNode row)
Parameters
PivotGroupNode row

The row.
Returns
System.Boolean

ScrollTo(Int32)

Scrolls the vertical scrollbar with the specified delta.

Declaration
public void ScrollTo(int delta)
Parameters
System.Int32 delta

The delta.

SelectAll()

Selects all.

Declaration
public void SelectAll()

SelectCell(PivotCellElement)

Selects a specific cell in the pivot grid.

Declaration
public void SelectCell(PivotCellElement cellElement)
Parameters
PivotCellElement cellElement

The cell element to select.

SelectCell(PivotCellElement, Boolean, Boolean)

Selects a cell in the pivot grid with additional selection modifiers.

Declaration
public void SelectCell(PivotCellElement cellElement, bool shift, bool ctrl)
Parameters
PivotCellElement cellElement

The cell element to select.
System.Boolean shift

When true, extends the selection from the current cell to this cell.
System.Boolean ctrl

When true, adds this cell to the current selection without deselecting other cells.

SelectCell(PivotGroupNode, PivotGroupNode)

Selects a cell at the intersection of the specified row and column.

Declaration
public void SelectCell(PivotGroupNode row, PivotGroupNode column)
Parameters
PivotGroupNode row

The row group node containing the cell to select.
PivotGroupNode column

The column group node containing the cell to select.

SelectCell(PivotGroupNode, PivotGroupNode, Boolean, Boolean)

Selects the cell.

Declaration
public void SelectCell(PivotGroupNode row, PivotGroupNode column, bool shift, bool ctrl)
Parameters
PivotGroupNode row

The row.
PivotGroupNode column

The column.
System.Boolean shift

The shift key is pressed.
System.Boolean ctrl

The CTRL key is pressed.

SelectColumn(PivotGroupNode)

Selects the column.

Declaration
public void SelectColumn(PivotGroupNode column)
Parameters
PivotGroupNode column

The column.

SelectColumn(PivotGroupNode, Boolean, Boolean)

Selects the column.

Declaration
public void SelectColumn(PivotGroupNode column, bool shift, bool ctrl)
Parameters
PivotGroupNode column

The column.
System.Boolean shift

The shift.
System.Boolean ctrl

The CTRL.

SelectRow(PivotGroupNode)

Selects the row.

Declaration
public void SelectRow(PivotGroupNode row)
Parameters
PivotGroupNode row

The row.

SelectRow(PivotGroupNode, Boolean, Boolean)

Selects the row.

Declaration
public void SelectRow(PivotGroupNode row, bool shift, bool ctrl)
Parameters
PivotGroupNode row

The row.
System.Boolean shift

Is the Shift key pressed
System.Boolean ctrl

Is the CTRL key pressed

SetGroupNodeSize(PivotGroupNode, Int32)

Sets the size of the group node.

Declaration
public void SetGroupNodeSize(PivotGroupNode node, int size)
Parameters
PivotGroupNode node

The node.
System.Int32 size

The size.

SetRowHeaderWidth(Int32, Int32)

Sets the width of the row header.

Declaration
public void SetRowHeaderWidth(int width, int level)
Parameters
System.Int32 width

The width.
System.Int32 level

The level.

ShowContextMenu(Point, RadElement)

Shows the context menu.

Declaration
public void ShowContextMenu(Point location, RadElement context)
Parameters
System.Drawing.Point location

The location.
RadElement context

The context.

ShowFieldChooser()

Shows the field chooser.

Declaration
public void ShowFieldChooser()

UpdateAfterExpandCollapse()

Updates the layout after expand collapse.

Declaration
public void UpdateAfterExpandCollapse()

UpdateOnResize()

Updates on resizing.

Declaration
public void UpdateOnResize()

UpdateUI()

Updates the UI.

Declaration
public void UpdateUI()

WaitComplete()

Waits the complete.

Declaration
public void WaitComplete()

Events

AggregateDescriptorElementCreating

Occurs when an aggregate descriptor element is being created, allowing customization of the element.

Declaration
public event AggregateDescriptorElementCreatingEventHandler AggregateDescriptorElementCreating
Event Type
AggregateDescriptorElementCreatingEventHandler

AggregatesPositionElementCreating

Occurs when an aggregates position element is being created, allowing customization of the element.

Declaration
public event AggregatesPositionElementCreatingEventHandler AggregatesPositionElementCreating
Event Type
AggregatesPositionElementCreatingEventHandler

CellCreating

Occurs when a cell is being created, allowing customization of the cell.

Declaration
public event PivotCellCreatingEventHandler CellCreating
Event Type
PivotCellCreatingEventHandler

CellFormatting

Occurs when a cell is being formatted, allowing customization of its appearance.

Declaration
public event PivotCellEventHandler CellFormatting
Event Type
PivotCellEventHandler

DataProviderChanged

Declaration
public event DataProviderChangedEventHandler DataProviderChanged
Event Type
DataProviderChangedEventHandler

FieldChooserShowing

Occurs when the field chooser form is about to be shown.

Declaration
public event FieldChooserShowingEventHandler FieldChooserShowing
Event Type
FieldChooserShowingEventHandler

FilterDescriptorElementCreating

Occurs when a filter descriptor element is being created, allowing customization of the element.

Declaration
public event FilterDescriptorElementCreatingEventHandler FilterDescriptorElementCreating
Event Type
FilterDescriptorElementCreatingEventHandler

GroupDescriptorElementCreating

Occurs when a group descriptor element is being created, allowing customization of the element.

Declaration
public event GroupDescriptorElementCreatingEventHandler GroupDescriptorElementCreating
Event Type
GroupDescriptorElementCreatingEventHandler

GroupElementCreating

Occurs when a group element is being created, allowing customization of the element.

Declaration
public event PivotGroupElementCreatingEventHandler GroupElementCreating
Event Type
PivotGroupElementCreatingEventHandler

GroupElementFormatting

Occurs when formatting a group element, allowing customization of its appearance.

Declaration
public event PivotGroupElementEventHandler GroupElementFormatting
Event Type
PivotGroupElementEventHandler

GroupExpandedChanged

Occurs when a group's expanded state changes.

Declaration
public event PivotGroupEventHandler GroupExpandedChanged
Event Type
PivotGroupEventHandler

PrintElementFormatting

Declaration
public event PrintElementEventHandler PrintElementFormatting
Event Type
PrintElementEventHandler

PrintElementPaint

Declaration
public event PrintElementPaintEventHandler PrintElementPaint
Event Type
PrintElementPaintEventHandler

RowCreating

Occurs when a row is being created, allowing customization of the row.

Declaration
public event PivotRowCreatingEventHandler RowCreating
Event Type
PivotRowCreatingEventHandler

RowFormatting

Occurs when a row is being formatted, allowing customization of its appearance.

Declaration
public event PivotRowEventHandler RowFormatting
Event Type
PivotRowEventHandler

SelectionChanged

Declaration
public event EventHandler SelectionChanged
Event Type
System.EventHandler

UpdateCompleted

Occurs when the grid completes updating its data and visual representation.

Declaration
public event EventHandler UpdateCompleted
Event Type
System.EventHandler

Explicit Interface Implementations

IChartDataProvider.SetChartView(ChartView)

Declaration
void IChartDataProvider.SetChartView(ChartView chartView)
Parameters
ChartView chartView

Implements

IChartDataProvider.UpdateChartData()

Declaration
void IChartDataProvider.UpdateChartData()
Implements

IPrintable.BeginPrint(RadPrintDocument, PrintEventArgs)

Declaration
int IPrintable.BeginPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Int32

Implements

IPrintable.EndPrint(RadPrintDocument, PrintEventArgs)

Declaration
bool IPrintable.EndPrint(RadPrintDocument sender, PrintEventArgs args)
Parameters
RadPrintDocument sender

System.Drawing.Printing.PrintEventArgs args

Returns
System.Boolean

Implements

IPrintable.GetSettingsDialog(RadPrintDocument)

Declaration
Form IPrintable.GetSettingsDialog(RadPrintDocument document)
Parameters
RadPrintDocument document

Returns
System.Windows.Forms.Form

Implements

IPrintable.PrintPage(Int32, RadPrintDocument, PrintPageEventArgs)

Declaration
bool IPrintable.PrintPage(int pageNumber, RadPrintDocument sender, PrintPageEventArgs args)
Parameters
System.Int32 pageNumber

RadPrintDocument sender

System.Drawing.Printing.PrintPageEventArgs args

Returns
System.Boolean

Implements

Extension Methods