RadPivotGrid
RadPivotGrid control. See the Overview topic for more information about this control.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[ToolboxBitmap(typeof(RadPivotGrid), "Toolbox.Icons.PivotGrid.png")]
[EmbeddedSkin("PivotGrid", typeof(RadPivotGrid))]
[EmbeddedSkin("PivotGrid", "Default", typeof(RadPivotGrid))]
[ClientScriptResource("Telerik.Web.UI.RadPivotGrid", "Telerik.Web.UI.PivotGrid.RadPivotGridScripts.js")]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadPivotGrid))]
[RequiredScript(typeof(MaterialRipple))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadTreeList))]
[TelerikToolboxCategory("Data")]
public class RadPivotGrid : RadCompositeDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IPostBackEventHandler, INamingContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlCompositeDataBoundControlRadCompositeDataBoundControlRadPivotGrid...
Implements:
Inherited Members
Constructors
public RadPivotGrid()Fields
AggregateFunctionChanged command constant
public const string AggregateFunctionChangedCommandName = "AggregateFunctionChanged"AggregateChange command constant
public const string AggregateLabelChangeCommandName = "AggregateChange"ChangePageSize command constant
public const string ChangePageSizeCommandName = "ChangePageSize"DeselectAll command constant
public const string DeselectAllCommandName = "DeselectAll"Deselect command constant
public const string DeselectCommandName = "Deselect"ExpandCollapse command constant
public const string ExpandCollapseCommandName = "ExpandCollapse"ExpandCollapseLevel command constant
public const string ExpandCollapseLevelCommandName = "ExpandCollapseLevel"FieldReorder command constant
public const string FieldReorderCommandName = "FieldReorder"Filter command constant
public const string FilterCommandName = "Filter"First page command constant
public const string FirstPageCommandArgument = "First"InitFilterDialogueCommandName command constant
public const string InitFilterDialogueCommandName = "InitFilterDialogue"Last page command constant
public const string LastPageCommandArgument = "Last"Next page command constant
public const string NextPageCommandArgument = "Next"Page command constant
public const string PageCommandName = "Page"PageSizeChanged command constant
public const string PageSizeChangedCommandName = "PageSizeChanged"Prev page command constant
public const string PrevPageCommandArgument = "Prev"Rebind command constant
public const string RebindPivotGridCommandName = "RebindPivotGrid"SelectAll command constant
public const string SelectAllCommandName = "SelectAll"Select command constant
public const string SelectCommandName = "Select"ShowHideField command constant
public const string ShowHideFieldCommandName = "ShowHideField"Sort command constant
public const string SortCommandName = "Sort"UpdateLayout command constant
public const string UpdateLayoutCommandName = "UpdateLayout"Properties
Gets a reference to the PivotGridAccessibilitySettings object that allows you to set the properties of the RadPivotGrid control's child controls for purpose and structure for user agents rendering to non-visual media such as speech and Braille
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridAccessibilitySettings AccessibilitySettings { get; }Gets or sets a value that indicates the aggregate level.
public int AggregatesLevel { get; set; }Gets or sets a value that indicates if the aggregate will be placed in the row axis or the column axis.
public PivotGridAxis AggregatesPosition { get; set; }Gets or sets a value indicating whether the filtering feature is enabled.
public virtual bool AllowFiltering { get; set; }Gets or sets a value indicating whether natural sorting is enabled.
public virtual bool AllowNaturalSort { get; set; }Gets or sets a value indicating whether the paging feature is enabled.
public virtual bool AllowPaging { get; set; }Gets or sets a value indicating whether the sorting feature is enabled.
public virtual bool AllowSorting { get; set; }Gets a reference to the PivotGridClientSettings object that allows you to set the properties of the client-side behavior and appearance in a Telerik RadPivotGrid control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridClientSettings ClientSettings { get; }Gets a collection of the pivot grid's collapsed column groups indexes.
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public HashSet<Array> CollapsedColumnIndexes { get; }Gets a collection of the pivot grid's collapsed row groups indexes.
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public HashSet<Array> CollapsedRowIndexes { get; }Style of the column grand totals' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style ColumnGrandTotalCellStyle { get; }Gets or sets the default expand state of all column groups which will be applied on initial load.
public bool ColumnGroupsDefaultExpanded { get; set; }Style of the column heades' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style ColumnHeaderCellStyle { get; }Gets or sets a value that indicates whether the column table layout is fixed or auto.
public virtual PivotGridTableLayout ColumnHeaderTableLayout { get; set; }Gets or sets the column zone text when there are no items added to the column header zone.
public virtual string ColumnHeaderZoneText { get; set; }Style of the column totals' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style ColumnTotalCellStyle { get; }Represents the PivotGridConfigurationPanel control which is used to manipulate fields and AggregatesPosition and AggregatesLevel values
public PivotGridConfigurationPanel ConfigurationPanel { get; }Returns a reference to the PivotGridConfigurationPanelSettings object. This group contains all settings related to the PivotGridConfigurationPanel
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridConfigurationPanelSettings ConfigurationPanelSettings { get; }Represents the ContextMenu RadMenu control
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridContextMenu ContextMenu { get; }Get/set the selected culture. Localization strings will be loaded based on this value.
public CultureInfo Culture { get; set; }Gets or sets a value indicating the index of the currently active page in case paging is enabled (AllowPaging is true).
[Bindable(true)]
[Browsable(false)]
public int CurrentPageIndex { get; set; }The index of the currently active page in case paging is enabled.
Exceptions: ArgumentOutOfRangeExceptionvalue is out of range.
Style of the data cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style DataCellStyle { get; }Gets or sets the data zone text when there are no items added to the data header zone.
public virtual string DataHeaderZoneText { get; set; }Gets or sets a value that will be displayed in data cells where aggragate values were empty.
public virtual string EmptyValue { get; set; }When set to true enables support for WAI-ARIA
public bool EnableAriaSupport { get; set; }Gets or sets a string that indicates whether the pivot model should be persisted into the session cache.
public bool EnableCaching { get; set; }Gets or sets if the RadPivotGrid configuration panel will be enabled. For customization use ConfigurationPanelSettings.
[Bindable(true)]
public virtual bool EnableConfigurationPanel { get; set; }The configuration panel enabled state.
Gets or sets a value indicating whether the NoRecordsTemplate will be visualized when no records are present
[Browsable(true)]
[Bindable(true)]
public bool EnableNoRecordsTemplate { get; set; }The default value is true.
Gets or sets a value indicating whether the ToolTips in the PivotGrid will be enabled feature.
public virtual bool EnableToolTips { get; set; }Gets or sets a value indicating whether the zone context menu should be enabled.
public virtual bool EnableZoneContextMenu { get; set; }true if the zone context menu feature is enabled; otherwise, false. Default is false.
Gets or sets a value that will be displayed in data cells where aggragate values could not be calculated.
public virtual string ErrorValue { get; set; }Gets a reference to the PivotGridExportSettings object that allows you to set the properties of the grouping operation in a Telerik RadGrid control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridExportSettings ExportSettings { get; }Gets a collection of PivotGridFieldsCollection objects.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridFieldsCollection Fields { get; }Field settings window. Used by RadPivotGrid configuration panel. For more information, please examine the Configuration Panel topic.
public PivotGridFieldSettingsWindow FieldSettingsWindow { get; }Gets a reference to PivotGridFieldsPopupSettings which holds all properties associated with the RadPivotGrid Fields Popup functionality which groups the fields in convinient popup in order to leave more space for the data to be displayed.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridFieldsPopupSettings FieldsPopupSettings { get; }Represents the FieldsWindow RadWindow control which holds all hidden fields
public PivotGridFieldsWindow FieldsWindow { get; }Represents the dialogues that manages the filter expressions for the TOP/Bottom filter operators.
public PivotGridFilterDialog FilterDialog { get; }Gets or sets the filter zone text when there are no items added to the filter header zone.
public virtual string FilterHeaderZoneText { get; set; }RadPivotGrid Filters collection. See the Filtering topic for more information.
[Browsable(false)]
public PivotGridFiltersCollection Filters { get; }Represents the window that manages the filter expressions for the pivot grid.
public PivotGridFilterWindow FilterWindow { get; }Gets the horizontal scroll div.
public Panel HorizontalScrollDiv { get; }protected bool IsNeedDataSourceInProgress { get; set; }Gets a collection of RadPivotGridDataItem objects that represent the data items of the current page of data in a RadPivotGrid control
[Browsable(false)]
public virtual PivotGridItemCollection Items { get; }Gets or sets a value indicating where RadPivotGrid will look for its .resx localization file. By default this file should be in the App_GlobalResources folder. However, if you cannot put the resource file in the default location or .resx files compilation is disabled for some reason (e.g. in a DotNetNuke environment), this property should be set to the location of the resource file.
public string LocalizationPath { get; set; }A relative path to the dialogs location. For example: "~/controls/RadPivotGridResources/".
If specified, the LocalizationPath property will allow you to load the grid localization file from any location in the web application.
Template that will be displayed if there is no aggregated data to show
[TemplateContainer(typeof(PivotGridNoRecordsItem))]
[Browsable(false)]
[Bindable(false)]
[PersistenceMode(PersistenceMode.InnerProperty)]
public ITemplate NoRecordsTemplate { get; set; }Gets or sets the text that will appear in the PivotGridNoRecordsItem when the default no records template is used.
public string NoRecordsText { get; set; }Gets a reference to the PivotGridOLAPSettings object that allows you to set the configuration parameters for OLAP binding in a Telerik RadPivotGrid control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridOLAPSettings OlapSettings { get; }Gets or sets a value indicating whether the Filter window of RadPivotGrid should have Overlay set to ensure popups are over a flash element or Java applet.
[Browsable(true)]
[Bindable(true)]
public bool Overlay { get; set; }The default value is false.
Gets the number of pages required to display the records of the data source in a RadPivotGrid control.
[Browsable(false)]
public virtual int PageCount { get; }Style used to change the appearance and styling of the pager
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual PivotGridPagerStyle PagerStyle { get; }Specify the maximum number of items that would appear in a page, when paging is enabled by AllowPaging property. Default value is 10.
public virtual int PageSize { get; set; }value is out of range.
Gets or sets a value that indicates whether the will be rendered into all empty data cells instead of empty string.
public bool RenderEmptyStringInDataCells { get; set; }Style of the row grand totals' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style RowGrandTotalCellStyle { get; }Gets or sets the default expand state of all row groups which will be applied on initial load.
public bool RowGroupsDefaultExpanded { get; set; }Style of the row heades' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style RowHeaderCellStyle { get; }Gets or sets a value that indicates whether the row table layout is fixed or auto.
public virtual PivotGridTableLayout RowHeaderTableLayout { get; set; }Gets or sets the header zone text when there are no items added to the row header zone.
public virtual string RowHeaderZoneText { get; set; }Gets or sets a value that indicates whether the row table layout will be Tabular, Outline or Fixed.
public PivotGridLayout RowTableLayout { get; set; }Style of the row totals' cells in the the pivotgrid.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual Style RowTotalCellStyle { get; }Gets or set a value indicating whether the column header zone of the pivotgrid will be shown.
[Bindable(true)]
public virtual bool ShowColumnHeaderZone { get; set; }This default value for this property is true.
Gets or set a value indicating whether the data header zone of the pivotgrid will be shown.
[Bindable(true)]
public virtual bool ShowDataHeaderZone { get; set; }This default value for this property is true.
Gets or set a value indicating whether the filter header zone of the pivotgrid will be shown.
[Bindable(true)]
public virtual bool ShowFilterHeaderZone { get; set; }This default value for this property is true.
Gets or set a value indicating whether the row header zone of the pivotgrid will be shown.
[Bindable(true)]
public virtual bool ShowRowHeaderZone { get; set; }This default value for this property is true.
Gets or sets the skin name for the control user interface.
public override string Skin { get; set; }A string containing the skin name for the control user interface. The default is string.Empty.
Overrides:
If this property is not set, the control will render using the skin named "Default". If EnableEmbeddedSkins is set to false, the control will not render skin.
Gets a collection of sort expressions for RadPivotGrid
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual PivotGridSortExpressionCollection SortExpressions { get; }protected override bool SupportsRenderingMode { get; }Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
Represents the control that manages the settings of the automatically generated tooltips in the PivotGrid
public PivotGridToolTipManager ToolTipManager { get; }Returns a reference to the PivotGridTotalsSettings object. This group contains all the settings that are related to the PivotGrid totals.
[PersistenceMode(PersistenceMode.InnerProperty)]
public PivotGridTotalsSettings TotalsSettings { get; }Gets or sets a value indicating whether the pivotgrid uses IQueryableDataProvider.
public virtual bool UseQueryableDataProvider { get; set; }Gets the vertical scroll div.
public Panel VerticalScrollDiv { get; }Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)Overrides:
protected virtual void AutoDataBind(PivotGridRebindReason rebindReason)protected virtual void CallAddingFieldToZone(PivotGridAddingFieldToZoneEventArgs e)protected virtual void CallAggregateLabelChange(PivotGridAggregateLabelChangeEventArgs e)protected virtual void CallCreated(PivotGridCellCreatedEventArgs e)protected virtual void CallDataBound(PivotGridCellDataBoundEventArgs e)protected virtual void CallDataProviderError(PivotGridDataProviderErrorEventArgs e)protected virtual void CallDataProviderStatusChanged(DataProviderStatusChangedEventArgs e)protected virtual void CallExpandCollapseLevel(PivotGridExpandCollapseLevelEventArgs e)protected virtual void CallFieldCreated(PivotGridFieldCreatedEventArgs e)protected virtual void CallFieldReorder(PivotGridFieldReorderEventArgs e)protected virtual void CallItemCreated(PivotGridItemCreatedEventArgs e)protected virtual void CallItemDataBound(PivotGridItemDataBoundEventArgs e)protected virtual void CallShowHideField(PivotGridShowHideFieldEventArgs e)protected virtual void CallUpdateLayout(PivotGridUpdateLayoutEventArgs e)Clears all previously applied filter expressions.
public void ClearAllFilters()Clears all filter expressions associated with a field.
public void ClearFilter(PivotGridField field)The PivotGridField which expressions will be cleared.
Clears all filter expressions associated with a field.
public void ClearFilter(string fieldUniqueName)The UniqueName which expressions will be cleared.
Collapses all column groups which are at the level of the specified field.
public void CollapseAllFieldGroups(PivotGridColumnField field, bool suppressRebind = false)The field which groups will be collapsed.
suppressRebindboolA value indicating whether a Rebind() will be called after the Sort operation.
Collapses all row groups which are at the level of the specified field.
public void CollapseAllFieldGroups(PivotGridRowField field, bool suppressRebind = false)The field which groups will be collapsed.
suppressRebindboolA value indicating whether a Rebind() will be called after the Sort operation.
protected override int CreateChildControls(IEnumerable dataSource, bool dataBinding)Overrides:
Binds a datasource to the invoked RadPivotGrid control and all its child controls.
public override void DataBind()Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
Expands all column groups which are at the level of the specified field.
public void ExpandAllFieldGroups(PivotGridColumnField field, bool suppressRebind = false)The field which groups will be expanded.
suppressRebindboolA value indicating whether a Rebind() will be called after the Sort operation.
Expands all row groups which are at the level of the specified field.
public void ExpandAllFieldGroups(PivotGridRowField field, bool suppressRebind = false)The field which groups will be expanded.
suppressRebindboolA value indicating whether a Rebind() will be called after the Sort operation.
Exports the pivot grid data in Microsoft Excel format using the properties set in the ExportSettings
public void ExportToExcel()Exports the pivot grid data in Microsoft Word format using the properties set in the ExportSettings
public void ExportToWord()When a Top/Bottom value filter is applied to a given field with the Items mode, it will select the top/bottom groups for that field sorted by the chosen aggregate field and the count of which is given by the filter value. For example, a Top operator with and Items filter value of 10 on the Sum of Cost aggregate field will return the 10 groups (of the field filtered on) which Sum of Cost is greatest. The Percent mode will return the top/bottom groups which cumulative aggregate values (just to remind: the aggregate field being set as part of the filter condition) add to the specified percent of the grand total for that field. The Sum mode, in a similar fashion, gets the top/bottom groups which cumulative aggregate values add to the sum specified by the filter value.
public void FilterBottom(PivotGridField field, PivotGridAggregateField aggregateField, PivotGridAggregateType aggregateType, double value, bool suppressRebind = false)The PivotGridField that will be filtered.
aggregateFieldPivotGridAggregateFieldThe PivotGridAggregateField that will be used to determine which values will be used when filtering.
aggregateTypePivotGridAggregateTypeThe aggregate type determining the mode which filters the data.
valuedoubleThe value that will be used for the filtering of the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
Filters by the text value of the field. Label filters control which groups for a given field will remain in the pivot data view after grouping has been performed. If, for example, you have your data grouped by a Country field and you need only those Country groups of items that relate to Bulgaria you should apply an Equals label filter to the Country field with the respective string filter value of “Bulgaria”.
public void FilterByLabel(PivotGridFilterFunction filterFunction, PivotGridField field, string filterValue, bool suppressRebind = false)The filter function to be applied to the filter expression.
fieldPivotGridFieldThe PivotGridField that will be filtered.
filterValuestringThe value that will be used for the filtering of the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
Filters by the text value of the field. Label filters control which groups for a given field will remain in the pivot data view after grouping has been performed.
public void FilterByLabel(PivotGridFilterFunction filterFunction, PivotGridField field, string filterValue, string betweenFilterValue, bool suppressRebind = false, bool ignoreCase = false)The filter function to be applied to the filter expression.
fieldPivotGridFieldThe PivotGridField that will be filtered.
filterValuestringThe value that will be used for the filtering of the data.
betweenFilterValuestringThe value that will be used as the between value when filtering the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
ignoreCaseboolA value indicating whether filtering will ignore the case of the value's letters or not.
Filters by the values of the field. Value filters, for their part, allow filtering operations to be performed on the aggregate results. Again, the filtering is applied after the grouping of the data. Here is another example: Suppose you have grouped your data by Country, aggregated it by Sum of Cost and need only those Country groups of items which cumulative cost falls within a certain range. Then you should apply a Between value filter on the Country field with the corresponding filter values.
public void FilterByValue(PivotGridFilterFunction filterFunction, PivotGridField field, PivotGridAggregateField aggregateField, string filterValue, bool suppressRebind = false)The filter function to be applied to the filter expression.
fieldPivotGridFieldThe PivotGridField that will be filtered.
aggregateFieldPivotGridAggregateFieldThe PivotGridAggregateField that will be used to determine which values will be used when filtering.
filterValuestringThe value that will be used for the filtering of the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
Filters by the values of the field. Value filters, for their part, allow filtering operations to be performed on the aggregate results. Again, the filtering is applied after the grouping of the data.
public void FilterByValue(PivotGridFilterFunction filterFunction, PivotGridField field, PivotGridAggregateField aggregateField, string filterValue, string betweenFilterValue, bool suppressRebind = false, bool ignoreCase = false)The filter function to be applied to the filter expression.
fieldPivotGridFieldThe PivotGridField that will be filtered.
aggregateFieldPivotGridAggregateFieldThe PivotGridAggregateField that will be used to determine which values will be used when filtering.
filterValuestringThe value that will be used for the filtering of the data.
betweenFilterValuestringThe value that will be used as the between value when filtering the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
ignoreCaseboolA value indicating whether filtering will ignore the case of the value's letters or not.
When a Top/Bottom value filter is applied to a given field with the Items mode, it will select the top/bottom groups for that field sorted by the chosen aggregate field and the count of which is given by the filter value. For example, a Top operator with and Items filter value of 10 on the Sum of Cost aggregate field will return the 10 groups (of the field filtered on) which Sum of Cost is greatest. The Percent mode will return the top/bottom groups which cumulative aggregate values (just to remind: the aggregate field being set as part of the filter condition) add to the specified percent of the grand total for that field. The Sum mode, in a similar fashion, gets the top/bottom groups which cumulative aggregate values add to the sum specified by the filter value.
public void FilterTop(PivotGridField field, PivotGridAggregateField aggregateField, PivotGridAggregateType aggregateType, double value, bool suppressRebind = false)The PivotGridField that will be filtered.
aggregateFieldPivotGridAggregateFieldThe PivotGridAggregateField that will be used to determine which values will be used when filtering.
aggregateTypePivotGridAggregateTypeThe aggregate type determining the mode which filters the data.
valuedoubleThe value that will be used for the filtering of the data.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
Returns a collection of PivotGridItem objects based on their ItemType.
public PivotGridItem[] GetItems(params PivotGridItemType[] types)The ItemType, which will be used as a criteria for the collection.
Returns:A PivotGridItems collection of objects based on their ItemType.
Method that returns a collection of all PivotGridRowZone objects in the current RadPivotGrid.
public List<PivotGridRowZone> GetRowZones()Returns a collection of all PivotGridRowZone objects in the current RadPivotGrid.
protected override IEnumerable<ScriptReference> GetScriptReferences()Overrides:
Gets zone by its type.
public PivotGridZone GetZoneByType(PivotGridZoneType type)Loads the client state data
protected override bool LoadClientState(Dictionary<string, object> clientState)Overrides:
Restores control-state information from a previous page request that was saved by the SaveControlState() method.
protected virtual void OnBiffExporting(PivotGridBiffExportingEventArgs e)protected virtual void OnFilterCommand(PivotGridFilterCommandEventArgs e)protected virtual void OnInitFilterDialogue(PivotGridInitFilterDialogueEventArgs e)Raises ItemCommand event
protected virtual void OnItemCommand(PivotGridCommandEventArgs e)Raises NeedDataSource event
protected virtual void OnNeedDataSource(PivotGridNeedDataSourceEventArgs e)protected virtual void OnPageIndexChanged(PivotGridPageChangedEventArgs e)protected virtual void OnPageSizeChanged(PivotGridPageSizeChangedEventArgs e)protected virtual void OnPivotGridCellExporting(PivotGridCellExportingArgs e)protected virtual void OnPivotGridExporting(PivotGridExportingArgs e)protected virtual void OnPivotGridInfrastructureExporting(PivotGridInfrastructureExportingEventArgs e)protected override void PerformSelect()Overrides:
Rebinds the RadPivotGrid control. Please see Advanced data-binding topic for more information.
public virtual void Rebind()protected override void RenderContents(HtmlTextWriter writer)Overrides:
Saves any RadPivotGrid control state changes that have occurred since the time the page was posted back to the server.
protected override object SaveControlState()Returns the RadPivotGrid's current state. If there is no state associated with the control, this method returns null.
Overrides:
Sets the values which will be excluded in the results of the RadPivotGrid.
public void SetFilterExcludes(string fieldUniqueName, IEnumerable<object> values, bool suppressRebind = false)The UniqueName which values will be filtered.
valuesIEnumerable<object>The values will be excluded in the results.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
Set the values which will be included in the results of the RadPivotGrid.
public void SetFilterIncludes(string fieldUniqueName, IEnumerable<object> values, bool suppressRebind = false)The UniqueName which values will be filtered.
valuesIEnumerable<object>The values that will be included in the results.
suppressRebindboolA value indicating whether a Rebind() will be called after the Filter operation.
protected virtual void SetStyleClasses()protected void SetUpPagingManager()Changes the sort order of the specified field.
public void Sort(PivotGridField field, bool suppressRebind = false)The field for which the sort order will be changed.
suppressRebindboolA value indicating whether a Rebind will be called after the Sort operation.
Changes the sort order of the specified field.
public void Sort(PivotGridField field, PivotGridSortOrder sortOrder, bool suppressRebind = false)The field for which the sort order will be changed.
sortOrderPivotGridSortOrderThe new sort order.
suppressRebindboolA value indicating whether a Rebind will be called after the Sort operation.
Executes the provided PivotGridSortExpression if it does not exist it will add it in the SortExpressions or otherwise will change the currently added.
public void Sort(PivotGridSortExpression expression, bool suppressRebind = false)A value indicating whether a Rebind() will be called after the Sort operation.
Executes the sort expressions which should contain the field UniqueName which will be sorted and optionally include the sort order - ASC (Ascending) or DESC (Descending).
Changes the sort order of the specified field.
public void Sort(string fieldUniqueName, PivotGridSortOrder sortOrder, bool suppressRebind = false)The UniqueName value of the field for which the sort order will be changed.
sortOrderPivotGridSortOrderThe new sort order.
suppressRebindboolA value indicating whether a Rebind will be called after the Sort operation.
protected override void TrackViewState()Overrides:
Tries to reorder the specified field with new ZoneType and/or new ZoneIndex.
public bool TryReorderField(PivotGridField field, PivotGridFieldZoneType zoneType, int zoneIndex)The field reference which will be reordered
zoneTypePivotGridFieldZoneTypeThe new ZoneType for the field
zoneIndexintThe new ZoneIndex for the field
Returns:If the reorder happened or not which could happen if the zoneType and zoneIndex are the same
Tries to reorder the specified field with new ZoneType and/or new ZoneIndex.
public bool TryReorderField(string fieldUniqueName, PivotGridFieldZoneType zoneType, int zoneIndex)The field unique name which will be reordered
zoneTypePivotGridFieldZoneTypeThe new ZoneType for the field
zoneIndexintThe new ZoneIndex for the field
Returns:If the reorder happened or not if the zoneType and zoneIndex are the same
Events
Raised before a PivotGridField is inserted into particular zone.
public event EventHandler<PivotGridAddingFieldToZoneEventArgs> AddingFieldToZoneCellCreated event. See RadPivotGrid Events topic for more information.
public event EventHandler<PivotGridCellCreatedEventArgs> CellCreatedCellDataBound event. See RadPivotGrid Events topic for more information.
public event EventHandler<PivotGridCellDataBoundEventArgs> CellDataBoundDataProviderError event. See RadPivotGrid Events topic for more information.
public event EventHandler<PivotGridDataProviderErrorEventArgs> DataProviderErrorpublic event EventHandler<DataProviderStatusChangedEventArgs> DataProviderStatusChangedEvent raised after a field have been added to the Fields collection.
public event EventHandler<PivotGridFieldCreatedEventArgs> FieldCreatedFires when all descrition fields are got from the cube.
public event EventHandler<GetDescriptionsDataCompletedEventArgs> GetDescriptionsDataCompletedRaised when a button in a RadPivotGrid control is clicked.
public event EventHandler<PivotGridCommandEventArgs> ItemCommandItem Created event. See RadPivotGrid Events topic for more information.
public event EventHandler<PivotGridItemCreatedEventArgs> ItemCreatedFires when calculation for Item or Field is needed.
public event EventHandler<PivotGridCalculationEventArgs> ItemNeedCalculationRaised when the RadPivotGrid is about to be bound and the data source must be assigned.
public event EventHandler<PivotGridNeedDataSourceEventArgs> NeedDataSourceFires when a paging action has been performed.
public event EventHandler<PivotGridPageChangedEventArgs> PageIndexChangedFires when PageSize has been changed.
public event EventHandler<PivotGridPageSizeChangedEventArgs> PageSizeChangedFires when a pivotgrid is exporting to BIFF format
public event EventHandler<PivotGridBiffExportingEventArgs> PivotGridBiffExportingFires when a pivotgrid cell is exporting.
public event EventHandler<PivotGridCellExportingArgs> PivotGridCellExportingFires when a pivotgrid is exporting.
public event EventHandler<PivotGridExportingArgs> PivotGridExportingFires when a PivotGrid is exporting to XLS/XLSX/DOCX formats.
public event EventHandler<PivotGridInfrastructureExportingEventArgs> PivotGridInfrastructureExportingFires when default description of the field is created.
public event EventHandler<PivotGridPrepareDescriptionForFieldEventArgs> PrepareDescriptionForFieldFires when Sort has been changed.
public event EventHandler<PivotGridSortEventArgs> Sorting