WinForms

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class PivotGridControl - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class PivotGridControl

    Represents a control that defines the pivot grid control with visual representation.

    Inheritance
    System.Object
    BaseControl
    PivotGridControl
    Implements
    IThemeProvider
    IVisualStyle
    System.IDisposable
    IPivotControl
    Inherited Members
    BaseControl.RaiseThemeChanged(Object, ThemeChangedEventArgs)
    BaseControl.GetActiveThemeName()
    BaseControl.ThemeName
    BaseControl.CanOverrideStyle
    BaseControl.IThemeProvider.BaseThemeName
    BaseControl.CanApplyTheme
    BaseControl.ControlName
    BaseControl.IVisualStyle.VisualTheme
    BaseControl.IsVisualStyleEnabled
    BaseControl.ThemeNameChanged
    Namespace: Syncfusion.Windows.Forms.PivotAnalysis
    Assembly: Syncfusion.PivotAnalysis.Windows.dll
    Syntax
    public class PivotGridControl : BaseControl, IThemeProvider, IVisualStyle, IDisposable, IPivotControl

    Constructors

    PivotGridControl()

    Initializes a new instance of the PivotGridControl class.

    Declaration
    public PivotGridControl()

    PivotGridControl(IContainer)

    Initializes a new instance of the PivotGridControl class with the specified System.ComponentModel.IContainer.

    Declaration
    public PivotGridControl(IContainer container)
    Parameters
    Type Name Description
    System.ComponentModel.IContainer container

    The System.ComponentModel.IContainer instance that provides the functionality of container.

    Properties

    AllowFiltering

    Gets or sets a value indicating whether to enable or disable the filtering.

    Declaration
    public bool AllowFiltering { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if filtering is enabled; otherwise, false. The default value is true.

    AllowRowPivotDrag

    Gets or sets a value indicating whether to enable or disable the drag and drop operation in RowPivotsOnly mode.

    Declaration
    public bool AllowRowPivotDrag { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the dragging row is enabled; otherwise, false. The default value isfalse.

    Remarks

    This property is used only when the RowPivotsOnly is set to true.

    AllowSorting

    Gets or sets a value indicating whether to enable or disable the sorting.

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

    IfTrueAllows the sorting;Otherwise False.

    BusyAnimationIcon

    Gets or sets the System.Drawing.Image value that needs to be displayed while Asynchronous process takes place.

    Declaration
    public Image BusyAnimationIcon { get; set; }
    Property Value
    Type Description
    System.Drawing.Image

    DeferLayoutUpdate

    Gets or sets a value indicating whether the layout should be updated immediately for dynamic change in PivotGrid's information or it should wait for a Refresh() call.

    Declaration
    public bool DeferLayoutUpdate { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the layout gets updated immediately; otherwise, false. The default value is false.

    EditManager

    Gets or sets the value of the PivotEditingManager.

    Declaration
    public PivotEditingManager EditManager { get; set; }
    Property Value
    Type Description
    PivotEditingManager
    Remarks

    This property is used only when EnableValueEditing is set to true.

    The EditManager handles direct editing of value cell contents. The PivotValueEdited event to allow for controlling what happens as the cell as the user leaves the cell. You should handle this event if you want to do any actions when a cell is completed. The default behavior will adjust the edit cell value so the newly typed entry is displayed. Also, any display value that depends upon this edited cell will also be updated. If you set e.Handled = true when you handle the event, then EditManager will make no changes to the displayed information, and it would be up to you to make any adjustments you want to see.

    The EditManager also has public properties AllowEditingOfTotalCells and HideExpanders that control whether you can edit Total cells and whether the expander glyphs are visible.

    The EditManager has public method GetRowColumnPivotValuesAt(Int32, Int32, out String) that return lists of pivot values and raw data items for a specified row and column.

    EnableAsyncLoading

    Gets or sets a value indicating whether to enable or disable asynchronous loading of a given PivotGridControl.

    Declaration
    public bool EnableAsyncLoading { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the asynchronous loading is enabled; otherwise, false. The default value is false.

    Remarks

    Enable this property, when the given PivotGridControl instance needs to be updated asynchronously on the background while other pivot operations are done.

    EnableTouchMode

    Gets or sets a value indicating whether to enable or disable the touch mode.

    Declaration
    public virtual bool EnableTouchMode { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the touch mode is enabled; otherwise, false. The default value is false.

    EnableUpdating

    Gets or sets a value indicating whether to enable or disable the updating of pivot cells.

    Declaration
    public bool EnableUpdating { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the updating is enabled; otherwise, false. The default value is false.

    EnableValueEditing

    Gets or sets a value indicating whether to enable or disable editing of value cells.

    Declaration
    public bool EnableValueEditing { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if value editing is enabled; otherwise, false. The default value is false.

    Filters

    Gets the collection of FilterExpression.

    Declaration
    public ObservableCollection<FilterExpression> Filters { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<FilterExpression>

    GridVisualStyles

    Gets or sets the GridVisualStyles enumeration value.

    Declaration
    public GridVisualStyles GridVisualStyles { get; set; }
    Property Value
    Type Description
    GridVisualStyles
    Examples

    This example shows how to use the GridVisualStyles property.

    // Sets the pivot grid to Office2007Blue.
    this.pivotGridControl1.GridVisualStyles = GridVisualStyles.Office2007Blue;
    ' Sets the pivot grid to Office2007Blue.
    Me.pivotGridControl1.GridVisualStyles = GridVisualStyles.Office2007Blue

    GridVisualStylesDrawing

    Gets or sets the value of VisualStylesDrawing object.

    Declaration
    public IVisualStylesDrawing GridVisualStylesDrawing { get; set; }
    Property Value
    Type Description
    IVisualStylesDrawing

    HiddenRowIndexes

    Gets the value of row indices that are hidden through filtering value columns.

    Declaration
    public HashSet<PivotCellInfo> HiddenRowIndexes { get; }
    Property Value
    Type Description
    System.Collections.Generic.HashSet<PivotCellInfo>
    Remarks

    This property is could be used only when the RowPivotsOnly is enabled.

    InAsyncMode

    Gets a value indicating whether the given PivotGridControl instance is in asynchronous mode or not.

    Declaration
    public bool InAsyncMode { get; }
    Property Value
    Type Description
    System.Boolean

    true if the asynchronous loading is enabled; otherwise, false. The default value is false.

    ItemSource

    Gets or sets the value of item source.

    Declaration
    public object ItemSource { get; set; }
    Property Value
    Type Description
    System.Object
    Examples

    This example shows how to use the ItemSource property.

    // Adding ItemSource to the pivot grid. Here "ProdutSales" is the datasource assigned to the grid.
    this.pivotGridControl1.ItemSource = ProductSales.GetSalesData();
    ' Adding ItemSource to the pivot grid. Here "ProdutSales" is the datasource assigned to the grid.
    Me.pivotGridControl1.ItemSource = ProductSales.GetSalesData()

    PivotCalculations

    Gets the collection of PivotComputationInfo.

    Declaration
    public ObservableCollection<PivotComputationInfo> PivotCalculations { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>
    Examples

    This example shows how to use the PivotCalculations property.

    // Adding PivotCalculations to the pivot grid.
    this.pivotGridControl1.PivotCalculations.Add(new PivotComputationInfo { FieldName = "Amount", Format = "#,##0", SummaryType = SummaryType.DoubleTotalSum});
    ' Adding PivotCalculations to the pivot grid.
    Me.pivotGridControl1.PivotCalculations.Add(New PivotComputationInfo With {.FieldName = "Amount", .Format = "#,##0", .SummaryType = SummaryType.DoubleTotalSum})

    PivotColumns

    Gets the collection of PivotItem.

    Declaration
    public ObservableCollection<PivotItem> PivotColumns { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<PivotItem>
    Examples

    This example shows how to use the PivotColumns property. Here "Country" is the field's mapping name and "Total" is the header.

    // Adding PivotColumns to the pivot grid.
    this.pivotGridControl1.PivotColumns.Add(new PivotItem { FieldMappingName = "Country", TotalHeader = "Total" });
    ' Adding PivotColumns to the pivot grid. Here "Country" is the field's mapping name and "Total" is the header.
    Me.pivotGridControl1.PivotColumns.Add(New PivotItem With {.FieldMappingName = "Country", .TotalHeader = "Total"})

    PivotEngine

    Gets or sets the PivotEngine.

    Declaration
    public PivotEngine PivotEngine { get; set; }
    Property Value
    Type Description
    PivotEngine

    PivotFields

    Gets the collection of PivotItem.

    Declaration
    public ObservableCollection<PivotItem> PivotFields { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<PivotItem>

    PivotRows

    Gets the collection of PivotItem.

    Declaration
    public ObservableCollection<PivotItem> PivotRows { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<PivotItem>
    Examples

    This example shows how to use the PivotRows property.

    // Adding PivotRows to the pivot grid. Here "Product" is the field's mapping name and "Total" is the header.
    this.pivotGridControl1.PivotRows.Add(new PivotItem { FieldMappingName = "Product", TotalHeader = "Total" });
    ' Adding PivotRows to the pivot grid. Here "Product" is the field's mapping name and "Total" is the header.
    Me.pivotGridControl1.PivotRows.Add(New PivotItem With {.FieldMappingName = "Product", .TotalHeader = "Total"})

    PivotSchemaDesigner

    Gets the value of the PivotSchemaDesigner instance wired within the PivotGridControl.

    Declaration
    public PivotSchemaDesigner PivotSchemaDesigner { get; }
    Property Value
    Type Description
    PivotSchemaDesigner

    PossiblePivotCalculations

    Gets or sets the collection of possible PivotComputationInfo instances that may appear in a given PivotGridControl.

    Declaration
    public ObservableCollection<PivotComputationInfo> PossiblePivotCalculations { get; set; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<PivotComputationInfo>
    Remarks

    This property is used only when the RowPivotsOnly is enabled.

    RowPivotsOnly

    Gets or sets a value indicating whether to enable or disable the row pivots only mode.

    Declaration
    public bool RowPivotsOnly { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the pivot rows alone is set; otherwise, false and sets both rows and columns. The default value is false.

    Remarks

    Specifies whether the PivotGridControl instance is used to analyze data only with rows, or with both rows and columns. Setting this property to true will produce the following changes:

    1. ShowGroupBar property will be automatically set to false.
    2. The TopLeft covered cell that normally appears in a PivotGrid is replaced with individual header cells that have the same appearance as that of Calculation header cells.

    ShowCalculationsAsColumns

    Gets or sets a value indicating whether the calculations should be shown as columns or not.

    Declaration
    public bool ShowCalculationsAsColumns { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the calculations are displayed as columns; otherwise, false. The default value is true.

    ShowGrandTotals

    Gets or sets a value indicating whether the grand total calculations should be computed by the engine or not.

    Declaration
    public bool ShowGrandTotals { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the calculations are computed by the engine; otherwise, false. The default value is true.

    ShowGroupBar

    Gets or sets a value indicating whether the grouping bar is shown or not.

    Declaration
    public bool ShowGroupBar { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the group bar is shown; otherwise, false. The default value is true.

    ShowPivotTableFieldList

    Gets or sets a value indicating whether to the PivotSchemaDesigner is shown or not.

    Declaration
    public bool ShowPivotTableFieldList { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the pivot table field list is shown; otherwise, false. The default value is false.

    ShowPivotValueChooser

    Gets or sets a value indicating whether pivot value chooser dialog is shown or not.

    Declaration
    public bool ShowPivotValueChooser { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the pivot value chooser is shown; otherwise, false. The default value is false.

    Remarks

    The PivotValueChooser allows the users to hide, show, or reorder the PivotCalculations in the RowPivotsOnly mode. Note: This property is used only when the RowPivotsOnly is set to true.

    ShowSubTotals

    Gets or sets a value indicating whether the subtotal values should be shown or not.

    Declaration
    public bool ShowSubTotals { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the subtotal values is shown; otherwise, false. The default value is true.

    TableControl

    Gets the value of PivotGridControlBase instance that implements a grid control which displays a grid model.

    Declaration
    public PivotGridControlBase TableControl { get; }
    Property Value
    Type Description
    PivotGridControlBase
    Examples

    This example shows how to use the TableControl property.

    // TableControl gets the all the information about the pivot grid table.
    this.pivotGridControl1.TableControl.BorderStyle = BorderStyle.FixedSingle;
    this.pivotGridControl1.TableControl.GroupDropArea.BackColor = Color.FromArgb(79, 80, 80);
    ' TableControl gets the all the information about the pivot grid table.
    Me.pivotGridControl1.TableControl.BorderStyle = BorderStyle.FixedSingle
    Me.pivotGridControl1.TableControl.GroupDropArea.BackColor = Color.FromArgb(79, 80, 80)

    TableModel

    Gets the value of GridModel instance that holds all data information about the grid.

    Declaration
    public GridModel TableModel { get; }
    Property Value
    Type Description
    GridModel
    Examples

    This example shows how to use the TableModel property.

    // TableModel property gets all the information about the pivot table.
    this.pivotGridControl1.TableModel.RowCount = 10;
    this.pivotGridControl1.TableModel.RowStyles[3].BackColor = Color.Red;
    this.pivotGridControl1.TableModel.Rows.DefaultSize = 20;
    this.pivotGridControl1.TableModel.TableStyle.BackColor = Color.FromArgb(23, 23, 23);
    this.pivotGridControl1.TableModel.TableStyle.TextColor = Color.FromArgb(230, 231, 232);
    ' TableModel property gets all the information about the pivot table.
    Me.pivotGridControl1.TableModel.RowCount = 10
    Me.pivotGridControl1.TableModel.RowStyles(3).BackColor = Color.Red
    Me.pivotGridControl1.TableModel.Rows.DefaultSize = 20
    Me.pivotGridControl1.TableModel.TableStyle.BackColor = Color.FromArgb(23, 23, 23)
    Me.pivotGridControl1.TableModel.TableStyle.TextColor = Color.FromArgb(230, 231, 232)

    ThemeStyle

    Gets or sets the PivotGridControlVisualStyle value used to customize the appearance of the .

    Declaration
    public PivotGridControlVisualStyle ThemeStyle { get; set; }
    Property Value
    Type Description
    PivotGridControlVisualStyle
    Remarks

    This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control.

    UpdateManager

    Gets or sets the value of PivotUpdatingManager.

    Declaration
    public PivotUpdatingManager UpdateManager { get; set; }
    Property Value
    Type Description
    PivotUpdatingManager
    Remarks

    This property is used only when the EnableUpdating is set to true. In order for the PivotGridControl to automatically respond to the changes in the underlying data, the underlying data must be either: A) a DataTable or DataView or B) an IList; where T implements both INotifyPropertyChanging and INotifyPropertyChanged. Additionally, the IList must also implement INotifyCollectionChanged or IBindingList."

    Methods

    ApplyFilters()

    Declaration
    public void ApplyFilters()

    ApplyFilters(Boolean)

    Performs the filtering operation.

    Declaration
    public void ApplyFilters(bool clearExistingFilter)
    Parameters
    Type Name Description
    System.Boolean clearExistingFilter

    Boolean value.

    Remarks

    Uses the contents of HiddenRowIndexes to display pivot results filtered using calculation values. Any previous filters optionally cleared depending upon clearExisitingFilter passed This method only affects the display when RowPivotsOnly is set to true.

    ApplyScaleToControl(Single)

    Applies the scaling to the PivotGridControl.

    Declaration
    public void ApplyScaleToControl(float sf)
    Parameters
    Type Name Description
    System.Single sf

    Represents floating number.

    AttachSchemaGeneric(Control)

    Performs visual representation.

    Declaration
    public void AttachSchemaGeneric(Control container)
    Parameters
    Type Name Description
    System.Windows.Forms.Control container

    Contains the components with visual representation.

    ClearFilters()

    Clears the filters and redraws the pivot display.

    Declaration
    public void ClearFilters()
    Examples

    This example shows how to clear the filters enabled in the grid.

    // Clears the filters in the pivot grid.
    this.pivotGridControl1.ClearFilters();
    ' Clears the filters in the pivot grid.
    Me.pivotGridControl1.ClearFilters()

    ClearFilters(Boolean)

    Clears the filters that depends on refreshing the PivotGridControl.

    Declaration
    public void ClearFilters(bool refresh)
    Parameters
    Type Name Description
    System.Boolean refresh

    Boolean value.

    Examples

    This example shows how to clear filters enabled in the grid.

    // Clears the filters in the pivot grid considering whether to refresh the grid or not.
    this.pivotGridControl1.ClearFilters(true);
    ' Clears the filters in the pivot grid considering whether to refresh the grid or not.
    Me.pivotGridControl1.ClearFilters(True)

    ColIndexToField(Int32)

    Gets the field index for the given column index.

    Declaration
    public int ColIndexToField(int colIndex)
    Parameters
    Type Name Description
    System.Int32 colIndex

    Column index.

    Returns
    Type Description
    System.Int32

    Field index.

    Examples

    This example shows how to get the field index of the specific column index.

    void TableControl_CellClick(object sender, Syncfusion.Windows.Forms.Grid.GridCellClickEventArgs e)
    {
       // Gets the specified field index from the given column index.
       int myFieldIndex = this.pivotGridControl1.ColIndexToField(e.ColIndex);
       Console.WriteLine("The field index of the specified column is " + myFieldIndex);
    }
    Private Sub TableControl_CellClick(ByVal sender As Object, ByVal e As Syncfusion.Windows.Forms.Grid.GridCellClickEventArgs)
       ' Gets the specified field index from the given column index.
       Dim myFieldIndex As Integer = Me.pivotGridControl1.ColIndexToField(e.ColIndex)
       Console.WriteLine("The field index of the specified column is " & myFieldIndex)
    End Sub

    CreatePivotGridControl(GridModel)

    Creates the new instance of the PivotGridControlBase class specifying the functionality of GridModel.

    Declaration
    public virtual PivotGridControlBase CreatePivotGridControl(GridModel model)
    Parameters
    Type Name Description
    GridModel model

    The grid model.

    Returns
    Type Description
    PivotGridControlBase

    A new PivotGridControlBaseinstance.

    Deserialize()

    Deserializes the PivotGrid from the desired XML file, selected using the open file dialog.

    Declaration
    public void Deserialize()

    Deserialize(Stream)

    Deserializes the PivotGrid from the specified file stream.

    Declaration
    public void Deserialize(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream data.

    Deserialize(Stream, DeserializationOptions)

    Deserializes the PivotGrid from the specified file stream with specific deserialization options.

    Declaration
    public void Deserialize(Stream stream, DeserializationOptions options)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream data.

    DeserializationOptions options

    The options to include/exclude the pivot grid properties during deserialization.

    Deserialize(String)

    Deserializes the PivotGrid from the specified XML file.

    Declaration
    public void Deserialize(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    The file name.

    Deserialize(String, DeserializationOptions)

    Deserializes the PivotGrid from the specified XML file with the specified deserialization options.

    Declaration
    public void Deserialize(string fileName, DeserializationOptions options)
    Parameters
    Type Name Description
    System.String fileName

    The file name.

    DeserializationOptions options

    The options to include/exclude the pivot grid properties during deserialization.

    DeserializeFromXml(String)

    Deserializes the PivotGrid with the settings specified in the XML string.

    Declaration
    public string DeserializeFromXml(string xmlString)
    Parameters
    Type Name Description
    System.String xmlString

    serialized file in xml string format

    Returns
    Type Description
    System.String

    Dispose(Boolean)

    Releases the managed resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    true, if managed resources should be disposed; otherwise, false.

    GetColumnIndexFromName(String)

    Gets the column index for the corresponding field name specified.

    Declaration
    public int GetColumnIndexFromName(string fieldName)
    Parameters
    Type Name Description
    System.String fieldName

    Stores the field name.

    Returns
    Type Description
    System.Int32

    Column index.

    Examples

    This example shows how to get the column index with the specified field name.

    // Gets the specified Column index of the field. Here "Amount" is the field name.
    int columnIndex = this.pivotGridControl1.GetColumnIndexFromName("Amount");
    Console.WriteLine("The Column index of the specified field is " + columnIndex);
    ' Gets the specified Column index of the field. Here "Amount" is the field name.
    Dim columnIndex As Integer = Me.pivotGridControl1.GetColumnIndexFromName("Amount")
    Console.WriteLine("The Column index of the specified field is " & columnIndex)

    GetControlName(String)

    Helps to apply the ControlName settings in control

    Declaration
    public override string GetControlName(string controlName)
    Parameters
    Type Name Description
    System.String controlName

    ControlName

    Returns
    Type Description
    System.String
    Overrides
    BaseControl.GetControlName(String)

    OnCanApplyThemeChanged(Boolean)

    Helps to apply the CanApplyTheme settings in control

    Declaration
    public override void OnCanApplyThemeChanged(bool canApplyTheme)
    Parameters
    Type Name Description
    System.Boolean canApplyTheme
    Overrides
    BaseControl.OnCanApplyThemeChanged(Boolean)

    OnCanOverrideStyleChanged(Boolean)

    Helps to apply the CanOverriderStyle settings in control

    Declaration
    public override void OnCanOverrideStyleChanged(bool canOverriderStyle)
    Parameters
    Type Name Description
    System.Boolean canOverriderStyle
    Overrides
    BaseControl.OnCanOverrideStyleChanged(Boolean)

    OnRightToLeftChanged(EventArgs)

    Overrides and handles the Right-to-Left changed event.

    Declaration
    protected override void OnRightToLeftChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    The System.EventArgs that contains the event data.

    OnThemeNameChanged(String)

    Helps to apply the ThemeName settings in control

    Declaration
    public override void OnThemeNameChanged(string themeName)
    Parameters
    Type Name Description
    System.String themeName

    ThemeName

    Overrides
    BaseControl.OnThemeNameChanged(String)

    ReapplyFiltersAfterSort()

    Re-applies the filter when the sorting is done.

    Declaration
    public void ReapplyFiltersAfterSort()

    Refresh()

    Refreshes the PivotGridControl.

    Declaration
    public void Refresh()

    Refresh(Boolean)

    Refreshes the PivotGridControl.

    Declaration
    public void Refresh(bool shouldPopulateEngine)
    Parameters
    Type Name Description
    System.Boolean shouldPopulateEngine

    Determines whether to populate the engine or not.

    Serialize()

    Serializes the PivotGrid to XML file in desired location using the save file dialog.

    Declaration
    public void Serialize()

    Serialize(Stream)

    Serializes the PivotGrid as stream and saves it in the default location.

    Declaration
    public void Serialize(Stream stream)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream data.

    Serialize(Stream, SerializationOptions)

    Serializes the PivotGrid as stream with specific serialization options.

    Declaration
    public void Serialize(Stream stream, SerializationOptions options)
    Parameters
    Type Name Description
    System.IO.Stream stream

    The stream data.

    SerializationOptions options

    The options to include/exclude the pivot grid properties during serialization.

    Serialize(String)

    Serializes the PivotGrid to specified XML file.

    Declaration
    public void Serialize(string fileName)
    Parameters
    Type Name Description
    System.String fileName

    The file name.

    Serialize(String, SerializationOptions)

    Serializes the PivotGrid to XML file with specific serialization options.

    Declaration
    public void Serialize(string fileName, SerializationOptions options)
    Parameters
    Type Name Description
    System.String fileName

    The file name.

    SerializationOptions options

    The options to include/exclude the pivot grid properties during serialization.

    SerializeToXml()

    Serializes the PivotGrid to string format.

    Declaration
    public string SerializeToXml()
    Returns
    Type Description
    System.String

    The serialized XML content in string format.

    Events

    AsyncLoadCompleted

    Handles the AsyncCompleted event.

    Declaration
    public event AsyncCompletedEventHandler AsyncLoadCompleted
    Event Type
    Type Description
    System.ComponentModel.AsyncCompletedEventHandler

    AsyncLoadStarted

    Handles the AsyncStarting event.

    Declaration
    public event AsyncStartingEventHandler AsyncLoadStarted
    Event Type
    Type Description
    AsyncStartingEventHandler

    FilterActionCompleted

    Occurs when the Filter action gets completed.

    Declaration
    public event PivotGridControl.FilterActionCompletedEventArgs FilterActionCompleted
    Event Type
    Type Description
    PivotGridControl.FilterActionCompletedEventArgs

    ItemSourceChanged

    Occurs when the ItemSource property value gets changed.

    Declaration
    public event ItemSourceChangedEventHandler ItemSourceChanged
    Event Type
    Type Description
    ItemSourceChangedEventHandler

    Implements

    IThemeProvider
    IVisualStyle
    System.IDisposable
    IPivotControl
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved