RadPivotGridElement
Represents the main element in RadPivotGrid
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.PivotGrid.dll
Syntax:
public class RadPivotGridElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IPrintable, IChartDataProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementRadPivotGridElement...
Implements:
Inherited Members
Constructors
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.
public RadPivotGridElement()
Fields
public static RadProperty ColumnHeaderHeightProperty
public static RadProperty ColumnWidthProperty
public const int DefaultColumnHeaderHeight = 30
public const int DefaultColumnWidth = 100
public const int DefaultFilterAreaHeight = 30
public const int DefaultRowHeight = 25
public static RadProperty DragHintProperty
public static RadProperty FilterAreaHeightProperty
public static RadProperty RowHeightProperty
Properties
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.
public AggregateDescriptionsCollection AggregateDescriptions { get; }
Gets the aggregate descriptors area.
public PivotAggregateDescriptorContainer AggregateDescriptorsArea { get; }
The aggregate descriptors area.
Gets or sets the aggregates level.
public int AggregatesLevel { get; set; }
The aggregates level.
Gets or sets the aggregates position.
public PivotAxis AggregatesPosition { get; set; }
The aggregates position.
Gets or sets whether to allow context menu.
public bool AllowContextMenu { get; set; }
The allow context menu.
Gets or sets whether the default screen tips are allowed.
public bool AllowDefaultScreenTips { get; set; }
The allow default screen tips.
Gets or sets whether the fields drag drop is allowed.
public bool AllowFieldsDragDrop { get; set; }
The allow fields drag drop.
Gets or sets whether the group filtering is allowed.
public bool AllowGroupFiltering { get; set; }
The allow group filtering.
Gets or sets whether the horizontal resize is allowed.
public bool AllowHorizontalResize { get; set; }
The allow horizontal resize.
Gets or sets whether the selection is allowed.
public bool AllowSelection { get; set; }
The allow selection.
Determines whether the sorting is allowed.
public bool AllowSorting { get; set; }
The allow sorting.
Determines whether the vertical resize is allowed.
public bool AllowVerticalResize { get; set; }
The allow vertical resize.
Gets or sets the auto expand column headers.
public bool AutoExpandColumnHeaders { get; set; }
The auto expand column headers.
Gets or sets the auto expand row headers.
public bool AutoExpandRowHeaders { get; set; }
The auto expand row headers.
Gets or sets the best fit helper.
public PivotBestFitHelper BestFitHelper { get; set; }
The best fit helper.
Gets or sets the chart data provider.
public PivotGridChartDataProvider ChartDataProvider { get; set; }
The chart data provider.
Gets the column descriptors area.
public PivotColumnDescriptorContainer ColumnDescriptorsArea { get; }
The column descriptors area.
Gets or sets the column grand totals position.
public TotalsPos ColumnGrandTotalsPosition { get; set; }
The column grand totals position.
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.
public ColumnGroupDescriptionCollection ColumnGroupDescriptions { get; }
Gets or sets the behavior that will set the expand or collapse state for column IGroups.
public IItemExpandBehavior<ExpandBehaviorParameters> ColumnGroupsExpandBehavior { get; set; }
Gets the column header container.
public PivotHeaderVirtualizedContainer ColumnHeaderContainer { get; }
The column header container.
Gets or sets the height of the column header.
[VsbBrowsable(true)]
public int ColumnHeaderHeight { get; set; }
The height of the column header.
Gets or sets the column headers layout.
public PivotLayout ColumnHeadersLayout { get; set; }
The column headers layout.
Gets the column root group.
public PivotGroupNode ColumnRootGroup { get; }
The column root group.
Gets the column scroller.
public ItemScroller<PivotGroupNode> ColumnScroller { get; }
The column scroller.
Gets or sets the columns sub totals position.
public TotalsPos ColumnsSubTotalsPosition { get; set; }
The columns sub totals position.
Gets or sets the width of the column.
[VsbBrowsable(true)]
public int ColumnWidth { get; set; }
The width of the column.
Gets or sets the context menu.
public PivotGridContextMenuBase ContextMenu { get; set; }
The context menu.
Gets or sets the data member.
[Browsable(true)]
public string DataMember { get; set; }
The data member.
Gets or sets the data provider.
public IDataProvider DataProvider { get; set; }
The data provider.
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.
public object DataSource { get; set; }
DialogsFactory
PivotGridDialogsFactory
Gets or sets the dialogs factory.
public PivotGridDialogsFactory DialogsFactory { get; set; }
The dialogs factory.
Gets or sets the drag drop service.
public PivotGridDragDropService DragDropService { get; set; }
The drag drop service.
Gets or sets the drag hint.
[VsbBrowsable(true)]
public RadImageShape DragHint { get; set; }
The drag hint.
Gets or sets the empty value string.
public string EmptyValueString { get; set; }
The empty value string.
Gets or sets the error string.
public string ErrorString { get; set; }
The error string.
Gets or sets the height of the filter area.
[VsbBrowsable(true)]
public int FilterAreaHeight { get; set; }
The height of the filter area.
Gets the filter descriptions.
public FilterDescriptionsCollection FilterDescriptions { get; }
The filter descriptions.
Gets the filter descriptors area.
public PivotFilterDescriptorContainer FilterDescriptorsArea { get; }
The filter descriptors area.
Gets the horizontal scroll bar.
public RadScrollBarElement HScrollBar { get; }
The H scroll bar.
Gets or sets whether the pivot element is busy.
public bool IsBusy { get; }
The is busy.
Gets the pivot rows container.
public PivotVirtualizedStackContainer PivotRowsContainer { get; }
The pivot rows container.
Gets or sets the print style.
public PivotGridPrintStyle PrintStyle { get; set; }
The print style.
Gets or sets the resizing behavior.
public ResizingBehavior ResizingBehavior { get; set; }
The resizing behavior.
Gets the row descriptors area.
public PivotRowDescriptorContainer RowDescriptorsArea { get; }
The row descriptors area.
Gets or sets the row grand totals position.
public TotalsPos RowGrandTotalsPosition { get; set; }
The row grand totals position.
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.
public RowGroupDescriptionCollection RowGroupDescriptions { get; }
Gets or sets the behavior that will set the expand or collapse state for row IGroups.
public IItemExpandBehavior<ExpandBehaviorParameters> RowGroupsExpandBehavior { get; set; }
Gets the row header container.
public PivotHeaderVirtualizedContainer RowHeaderContainer { get; }
The row header container.
Gets or sets the row headers layout.
public PivotLayout RowHeadersLayout { get; set; }
The row headers layout.
Gets or sets the height of the row.
[VsbBrowsable(true)]
public int RowHeight { get; set; }
The height of the row.
Gets the row root group.
public PivotGroupNode RowRootGroup { get; }
The row root group.
Gets the row scroller.
public ItemScroller<PivotGroupNode> RowScroller { get; }
The row scroller.
Gets or sets the rows sub totals position.
public TotalsPos RowsSubTotalsPosition { get; set; }
The rows sub totals position.
Gets or sets whether to show the filter area.
public bool ShowFilterArea { get; set; }
The show filter area.
Gets the V scroll bar.
public RadScrollBarElement VScrollBar { get; }
The V scroll bar.
Gets the waiting bar.
public RadWaitingBarElement WaitingBar { get; }
The waiting bar.
Methods
Begins the update operation.
public void BeginUpdate()
Clears all cell selections in the pivot grid.
public void ClearSelection()
Returns whether the column contains selection.
public bool ColumnContainsSelection(PivotGroupNode column)
The column.
Returns:Copies the selection to clipboard.
public void CopySelectionToClipboard()
Copies to clipboard.
public void CopyToClipboard(PivotGroupNode startRow, PivotGroupNode startColumn, PivotGroupNode endRow, PivotGroupNode endColumn, bool selectedOnly)
The start row.
startColumnPivotGroupNodeThe start column.
endRowPivotGroupNodeThe end row.
endColumnPivotGroupNodeThe end column.
selectedOnlyboolIndicates whether the selection only will be processed.
Copies to clipboard.
public void CopyToClipboard(PivotGroupNode startRow, PivotGroupNode startColumn, PivotGroupNode endRow, PivotGroupNode endColumn)
The start row.
startColumnPivotGroupNodeThe start column.
endRowPivotGroupNodeThe end row.
endColumnPivotGroupNodeThe end column.
Called by the element when constructed. Allows inheritors to build the element tree.
protected override void CreateChildElements()
Overrides:
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.
public void DataBind()
Defers the refresh.
Disposes the managed resources.
protected override void DisposeManagedResources()
Overrides:
Occurs when the DPI scale is changed.
public override void DpiScaleChanged(SizeF scaleFactor)
The scale factor.
Overrides:
Ends the update operation.
public void EndUpdate()
Gets the cell element.
public PivotCellElement GetCellElement(PivotGroupNode row, PivotGroupNode column)
The row.
columnPivotGroupNodeThe column.
Returns:Gets the column groups.
Gets the group element.
public PivotGroupElement GetGroupElement(PivotGroupNode node)
The node.
Returns:Gets the size of the group node.
Gets the row element.
public PivotRowElement GetRowElement(PivotGroupNode row)
The row.
Returns:Gets the row groups.
Determines whether the cell is selected.
public bool IsCellSelected(PivotGroupNode row, PivotGroupNode column)
The row.
columnPivotGroupNodeThe column.
Returns:Called when the aggregate description element is being created.
protected virtual PivotAggregateDescriptorElement OnAggregateDescriptionElementCreating(PivotAggregateDescriptorElement element)
The element.
Returns:Called when the aggregates position element is being created.
protected virtual AggregatesPositionDescriptorElement OnAggregatesPositionElementCreating(AggregatesPositionDescriptorElement element)
The element.
Returns:Raises the event.
protected virtual void OnCellCreating(PivotCellCreatingEventArgs args)
The PivotCellCreatingEventArgs instance containing the event data.
Called when the cell is being formatted.
protected virtual void OnCellFormatting(PivotCellElement cell)
The cell.
Called when the data provider is changed.
protected virtual void OnDataProviderChanged(IDataProvider newProvider, IDataProvider oldProvider)
The new provider.
oldProviderIDataProviderThe old provider.
Raises the event.
protected virtual void OnFieldChooserShowing(FieldChooserShowingEventArgs args)
The FieldChooserShowingEventArgs instance containing the event data.
Called when the filter description element is being created.
protected virtual PivotFilterDescriptorElement OnFilterDescriptionElementCreating(PivotFilterDescriptorElement element)
The element.
Returns:Called when the group description element is being created.
protected virtual PivotGroupDescriptorElement OnGroupDescriptionElementCreating(PivotGroupDescriptorElement element, PivotAxis axis)
The element.
axisPivotAxisThe axis.
Returns:Raises the event.
protected virtual void OnGroupElementCreating(PivotGroupElementCreatingEventArgs args)
The PivotGroupElementCreatingEventArgs instance containing the event data.
Raises the event.
protected virtual void OnGroupElementFormatting(PivotGroupElementEventArgs args)
The PivotGroupElementEventArgs instance containing the event data.
Raises the event.
protected virtual void OnGroupExpandedChanged(PivotGroupEventArgs args)
The PivotGroupEventArgs instance containing the event data.
Called when the print element is being formatted.
protected virtual void OnPrintElementFormatting(RadPrintElement printElement)
The print element.
Called when the print element is painted.
protected virtual void OnPrintElementPaint(RadPrintElement printElement, Graphics g, Rectangle bounds)
The print element.
gGraphicsThe g.
boundsRectangleThe bounds.
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Event arguments containing information about the property that changed.
Overrides:
Raises the event.
protected virtual void OnRowCreating(PivotRowCreatingEventArgs args)
The PivotRowCreatingEventArgs instance containing the event data.
Called when the row is being formatting.
protected virtual void OnRowFormatting(PivotRowElement row)
The row.
Called when the selection is changed.
protected virtual void OnSelectionChanged()
Called when the update is completed.
protected virtual void OnUpdateCompleted()
Directly prints the RadPivotGrid to the default printer.
public virtual void Print()
Directly prints the RadPivotGrid to the default printer or shows printer settitngs and then prints the RadPivotGrid.
public virtual void Print(bool showPrinterSettings, RadPrintDocument document)
Indicates whether printer settings dialog should be shown.
documentRadPrintDocumentAs instance of RadPrintDocument used to control the print process.
Directly prints the RadPivotGrid to the default printer or shows printer settitngs and then prints the RadPivotGrid.
public virtual void Print(bool showPrinterSettings)
Indicates whether printer settings dialog should be shown.
Shows a RadPrintPreviewDialog for editing the RadPivotGrid print settings.
public virtual void PrintPreview()
Shows a RadPrintPreviewDialog for editing the RadPivotGrid print settings.
public virtual void PrintPreview(RadPrintDocument document)
As instance of RadPrintDocument used to control the print process.
public void ProcessGroupPropertyChanged(PivotGroupNode groupNode, string propertyName)
Processes the key down.
public virtual bool ProcessKeyDown(KeyEventArgs e)
The KeyEventArgs instance containing the event data.
Returns:Processes the mouse down.
public virtual bool ProcessMouseDown(MouseEventArgs e)
The MouseEventArgs instance containing the event data.
Returns:Processes the mouse move.
public virtual bool ProcessMouseMove(MouseEventArgs e)
The MouseEventArgs instance containing the event data.
Returns:Processes the mouse up.
public virtual bool ProcessMouseUp(MouseEventArgs e)
The MouseEventArgs instance containing the event data.
Returns:Processes the mouse wheel.
public virtual bool ProcessMouseWheel(MouseEventArgs e)
The MouseEventArgs instance containing the event data.
Returns:Processes the screen tip.
public virtual bool ProcessScreenTip(ScreenTipNeededEventArgs e)
The ScreenTipNeededEventArgs instance containing the event data.
Returns:Refreshes the data.
public void RefreshData()
Returns whether the row contains selection.
public bool RowContainsSelection(PivotGroupNode row)
The row.
Returns:Scrolls the vertical scrollbar with the specified delta.
Selects all.
public void SelectAll()
Selects a cell in the pivot grid with additional selection modifiers.
public void SelectCell(PivotCellElement cellElement, bool shift, bool ctrl)
The cell element to select.
shiftboolWhen true, extends the selection from the current cell to this cell.
ctrlboolWhen true, adds this cell to the current selection without deselecting other cells.
Selects a specific cell in the pivot grid.
public void SelectCell(PivotCellElement cellElement)
The cell element to select.
Selects the cell.
public void SelectCell(PivotGroupNode row, PivotGroupNode column, bool shift, bool ctrl)
The row.
columnPivotGroupNodeThe column.
shiftboolThe shift key is pressed.
ctrlboolThe CTRL key is pressed.
Selects a cell at the intersection of the specified row and column.
public void SelectCell(PivotGroupNode row, PivotGroupNode column)
The row group node containing the cell to select.
columnPivotGroupNodeThe column group node containing the cell to select.
Selects the column.
public void SelectColumn(PivotGroupNode column, bool shift, bool ctrl)
The column.
shiftboolThe shift.
ctrlboolThe CTRL.
Selects the column.
Selects the row.
public void SelectRow(PivotGroupNode row, bool shift, bool ctrl)
The row.
shiftboolIs the Shift key pressed
ctrlboolIs the CTRL key pressed
Selects the row.
Sets the size of the group node.
public void SetGroupNodeSize(PivotGroupNode node, int size)
The node.
sizeintThe size.
Shows the context menu.
public void ShowContextMenu(Point location, RadElement context)
The location.
contextRadElementThe context.
Shows the field chooser.
public void ShowFieldChooser()
Updates the layout after expand collapse.
public void UpdateAfterExpandCollapse()
Updates on resizing.
public void UpdateOnResize()
Updates the UI.
public void UpdateUI()
Waits the complete.
public void WaitComplete()
Events
Occurs when an aggregate descriptor element is being created, allowing customization of the element.
public event AggregateDescriptorElementCreatingEventHandler AggregateDescriptorElementCreating
Occurs when an aggregates position element is being created, allowing customization of the element.
public event AggregatesPositionElementCreatingEventHandler AggregatesPositionElementCreating
Occurs when a cell is being created, allowing customization of the cell.
public event PivotCellCreatingEventHandler CellCreating
Occurs when a cell is being formatted, allowing customization of its appearance.
public event PivotCellEventHandler CellFormatting
public event DataProviderChangedEventHandler DataProviderChanged
Occurs when the field chooser form is about to be shown.
public event FieldChooserShowingEventHandler FieldChooserShowing
Occurs when a filter descriptor element is being created, allowing customization of the element.
public event FilterDescriptorElementCreatingEventHandler FilterDescriptorElementCreating
Occurs when a group descriptor element is being created, allowing customization of the element.
public event GroupDescriptorElementCreatingEventHandler GroupDescriptorElementCreating
Occurs when a group element is being created, allowing customization of the element.
public event PivotGroupElementCreatingEventHandler GroupElementCreating
Occurs when formatting a group element, allowing customization of its appearance.
public event PivotGroupElementEventHandler GroupElementFormatting
Occurs when a group's expanded state changes.
public event PivotGroupEventHandler GroupExpandedChanged
public event PrintElementEventHandler PrintElementFormatting
public event PrintElementPaintEventHandler PrintElementPaint
Occurs when a row is being created, allowing customization of the row.
public event PivotRowCreatingEventHandler RowCreating
Occurs when a row is being formatted, allowing customization of its appearance.
public event PivotRowEventHandler RowFormatting
public event EventHandler SelectionChanged
Occurs when the grid completes updating its data and visual representation.
public event EventHandler UpdateCompleted