Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Collapse]DevExpress.XtraPivotGrid
   [Expand]CancelPivotCellEditEventArgs Class
   [Expand]CustomCustomizationFormSortEventArgs Class
   [Expand]CustomEditValueEventArgs Class
    CustomEditValueEventHandler Delegate
   [Expand]CustomExportCellEventArgs Class
   [Expand]CustomExportFieldValueEventArgs Class
   [Expand]CustomExportHeaderEventArgs Class
   [Expand]CustomFieldDataEventArgs Class
    CustomFieldDataEventHandler Delegate
   [Expand]CustomizationFormShowingEventArgs Class
    CustomizationFormShowingEventHandler Delegate
   [Expand]CustomizePivotCellEventArgs Class
    CustomizePivotCellEventHandler Delegate
   [Expand]CustomServerModeSortEventArgs Class
   [Expand]EditValueChangedEventArgs Class
    EditValueChangedEventHandler Delegate
    ExcelFilterDateTimeValuesTabFilterType Enumeration
    ExcelFilterDefaultTab Enumeration
    ExcelFilterEnumFilters Enumeration
    ExcelFilterNumericValuesTabFilterType Enumeration
    ExcelFilterTextFilters Enumeration
    FieldFilterPopupMode Enumeration
   [Expand]FieldValueCell Class
   [Expand]FilterPopupExcelCustomizeTemplateEventArgs Class
    FilterPopupExcelCustomizeTemplateEventHandler Delegate
   [Expand]FilterPopupExcelDataEventArgs Class
    FilterPopupExcelDataEventHandler Delegate
   [Expand]FilterPopupExcelEventArgs Class
    FilterPopupExcelEventHandler Delegate
   [Expand]FilterPopupExcelPrepareTemplateEventArgs Class
    FilterPopupExcelPrepareTemplateEventHandler Delegate
   [Expand]FilterPopupExcelQueryFilterCriteriaEventArgs Class
    FilterPopupExcelQueryFilterCriteriaEventHandler Delegate
    FilterPopupToolbarButtons Enumeration
   [Expand]FormatRuleFieldIntersectionSettings Class
   [Expand]FormatRuleSettings Class
   [Expand]FormatRuleTotalTypeSettings Class
   [Expand]PivotAreaChangingEventArgs Class
    PivotAreaChangingEventHandler Delegate
   [Expand]PivotCellBaseEventArgs Class
   [Expand]PivotCellDisplayTextEventArgs Class
    PivotCellDisplayTextEventHandler Delegate
   [Expand]PivotCellEditEventArgs Class
   [Expand]PivotCellEventArgs Class
    PivotCellEventHandler Delegate
   [Expand]PivotCellValueEventArgs Class
   [Expand]PivotContextMenuIds Class
   [Expand]PivotCustomAppearanceEventArgs Class
    PivotCustomAppearanceEventHandler Delegate
   [Expand]PivotCustomAppearanceThreadSafeEventArgs Class
   [Expand]PivotCustomCellEditEventArgs Class
   [Expand]PivotCustomChartDataSourceDataEventArgs Class
    PivotCustomChartDataSourceDataEventHandler Delegate
   [Expand]PivotCustomChartDataSourceRowsEventArgs Class
    PivotCustomChartDataSourceRowsEventHandler Delegate
   [Expand]PivotCustomColumnWidthEventArgs Class
   [Expand]PivotCustomDrawBaseThreadSafeEventArgs Class
   [Expand]PivotCustomDrawCellBaseEventArgs Class
   [Expand]PivotCustomDrawCellBaseThreadSafeEventArgs Class
   [Expand]PivotCustomDrawCellEventArgs Class
    PivotCustomDrawCellEventHandler Delegate
   [Expand]PivotCustomDrawCellThreadSafeEventArgs Class
   [Expand]PivotCustomDrawEventArgs Class
    PivotCustomDrawEventHandler Delegate
   [Expand]PivotCustomDrawFieldHeaderEventArgs Class
    PivotCustomDrawFieldHeaderEventHandler Delegate
   [Expand]PivotCustomDrawFieldHeaderThreadSafeEventArgs Class
   [Expand]PivotCustomDrawFieldValueEventArgs Class
    PivotCustomDrawFieldValueEventHandler Delegate
   [Expand]PivotCustomDrawFieldValueThreadSafeEventArgs Class
   [Expand]PivotCustomDrawHeaderAreaEventArgs Class
    PivotCustomDrawHeaderAreaEventHandler Delegate
   [Expand]PivotCustomDrawHeaderAreaThreadSafeEventArgs Class
   [Expand]PivotCustomDrawThreadSafeEventArgs Class
   [Expand]PivotCustomFieldValueCellsEventArgs Class
    PivotCustomFieldValueCellsEventHandler Delegate
   [Expand]PivotCustomFilterPopupItemsEventArgs Class
    PivotCustomFilterPopupItemsEventHandler Delegate
   [Expand]PivotCustomGroupIntervalEventArgs Class
    PivotCustomGroupIntervalEventHandler Delegate
   [Expand]PivotCustomRowHeightEventArgs Class
    PivotEndUpdateMode Enumeration
   [Expand]PivotFieldDisplayTextEventArgs Class
    PivotFieldDisplayTextEventHandler Delegate
   [Expand]PivotFieldEventArgs Class
    PivotFieldEventHandler Delegate
   [Expand]PivotFieldFilterChangingEventArgs Class
    PivotFieldFilterChangingEventHandler Delegate
   [Expand]PivotFieldImageIndexEventArgs Class
    PivotFieldImageIndexEventHandler Delegate
   [Expand]PivotFieldImageIndexThreadSafeEventArgs Class
   [Expand]PivotFieldPropertyChangedEventArgs Class
    PivotFieldPropertyChangedEventHandler Delegate
   [Expand]PivotFieldTooltipShowingEventArgs Class
    PivotFieldTooltipShowingEventHandler Delegate
   [Expand]PivotFieldValueCancelEventArgs Class
    PivotFieldValueCancelEventHandler Delegate
   [Expand]PivotFieldValueEventArgs Class
    PivotFieldValueEventHandler Delegate
   [Expand]PivotFieldValueHitInfo Class
   [Expand]PivotFilter Class
   [Expand]PivotGridAppearances Class
   [Expand]PivotGridAppearancesBase Class
   [Expand]PivotGridAppearancesPrint Class
   [Expand]PivotGridCells Class
   [Collapse]PivotGridControl Class
     PivotGridControl Members
     PivotGridControl Constructor
    [Expand]PivotGridControl Properties
    [Expand]PivotGridControl Events
    [Collapse]PivotGridControl Methods
      About Method
      BeginUpdate Method
     [Expand]BestFit Method
      BestFitColumnArea Method
      BestFitDataHeaders Method
      BestFitRowArea Method
      CalcHitInfo Method
      CanResizeField Method
     [Expand]ChangeFieldExpandedAsync Method
     [Expand]ChangeFieldSortOrderAsync Method
     [Expand]ClearFieldSortingAsync Method
     [Expand]CloseEditor Method
      CollapseAll Method
     [Expand]CollapseAllAsync Method
      CollapseAllColumns Method
     [Expand]CollapseAllColumnsAsync Method
      CollapseAllRows Method
     [Expand]CollapseAllRowsAsync Method
      CollapseValue Method
     [Expand]CollapseValueAsync Method
      ConvertFormatConditionToFormatRules Method
     [Expand]CreateDrillDownDataSource Method
     [Expand]CreateDrillDownDataSourceAsync Method
      CreateOLAPDataSourceClone Method
     [Expand]CreateOLAPDrillDownDataSource Method
     [Expand]CreateOLAPDrillDownDataSourceAsync Method
     [Expand]CreateServerModeDrillDownDataSource Method
     [Expand]CreateServerModeDrillDownDataSourceAsync Method
      CreateSummaryDataSource Method
      DestroyCustomization Method
      EndUpdate Method
     [Expand]EndUpdateAsync Method
      EnsureViewInfoIsCalculated Method
      ExpandAll Method
     [Expand]ExpandAllAsync Method
      ExpandAllColumns Method
     [Expand]ExpandAllColumnsAsync Method
      ExpandAllRows Method
     [Expand]ExpandAllRowsAsync Method
      ExpandValue Method
     [Expand]ExpandValueAsync Method
     [Expand]ExportToCsv Method
     [Expand]ExportToDocx Method
     [Expand]ExportToHtml Method
     [Expand]ExportToImage Method
     [Expand]ExportToMht Method
     [Expand]ExportToPdf Method
     [Expand]ExportToRtf Method
     [Expand]ExportToText Method
     [Expand]ExportToXls Method
     [Expand]ExportToXlsx Method
     [Expand]FieldsCustomization Method
      ForceInitialize Method
     [Expand]GetCellValue Method
     [Expand]GetColumnIndex Method
      GetFieldAt Method
      GetFieldByArea Method
      GetFieldList Method
      GetFieldsByArea Method
      GetFieldValue Method
      GetFieldValueOLAPMember Method
     [Expand]GetFieldValueType Method
      GetKPIBitmap Method
      GetOLAPKPIList Method
      GetOLAPKPIMeasures Method
      GetOLAPKPIServerGraphic Method
      GetOLAPKPIValue Method
     [Expand]GetRowIndex Method
      HideCustomization Method
      HideEditor Method
     [Expand]IsObjectCollapsed Method
      LayoutChanged Method
      LoadCollapsedStateFromFile Method
      LoadCollapsedStateFromStream Method
     [Expand]PostEditor Method
      Print Method
      RefreshData Method
     [Expand]RefreshDataAsync Method
     [Expand]RestoreLayoutFromRegistry Method
     [Expand]RestoreLayoutFromStream Method
     [Expand]RestoreLayoutFromXml Method
     [Expand]RetrieveFields Method
     [Expand]RetrieveFieldsAsync Method
      SaveCollapsedStateToFile Method
      SaveCollapsedStateToStream Method
     [Expand]SaveLayoutToRegistry Method
     [Expand]SaveLayoutToStream Method
     [Expand]SaveLayoutToXml Method
     [Expand]SavePivotGridToFile Method
     [Expand]SavePivotGridToStream Method
     [Expand]SetDataSourceAsync Method
     [Expand]SetFieldSortingAsync Method
     [Expand]SetOLAPConnectionStringAsync Method
      ShowCustomization Method
     [Expand]ShowEditor Method
      ShowPrintPreview Method
      ShowRibbonPrintPreview Method
      ShowUnboundExpressionEditor Method
      ValidateEditor Method
      XtraFindFieldsItem Method
   [Expand]PivotGridCustomFieldSortEventArgs Class
    PivotGridCustomFieldSortEventHandler Delegate
   [Expand]PivotGridCustomSummaryEventArgs Class
    PivotGridCustomSummaryEventHandler Delegate
   [Expand]PivotGridCustomTotal Class
   [Expand]PivotGridCustomTotalCollection Class
   [Expand]PivotGridField Class
   [Expand]PivotGridFieldAppearances Class
   [Expand]PivotGridFieldCollection Class
   [Expand]PivotGridFieldImageOptions Class
   [Expand]PivotGridFieldOptionsEx Class
   [Expand]PivotGridFieldOptionsFilter Class
   [Expand]PivotGridFieldToolTips Class
   [Expand]PivotGridFormatConditionCollection Class
   [Expand]PivotGridFormatRule Class
   [Expand]PivotGridFormatRuleCollection Class
    PivotGridHeaderHitTest Enumeration
   [Expand]PivotGridHeadersAreaHitInfo Class
   [Expand]PivotGridHitInfo Class
    PivotGridHitTest Enumeration
   [Expand]PivotGridMenuEventArgs Class
   [Expand]PivotGridMenuEventArgsBase Class
    PivotGridMenuEventHandler Delegate
   [Expand]PivotGridMenuItemClickEventArgs Class
   [Expand]PivotGridMenuItemClickEventArgsBase Class
    PivotGridMenuItemClickEventHandler Delegate
    PivotGridMenuType Enumeration
   [Expand]PivotGridOptionsBehavior Class
   [Expand]PivotGridOptionsCustomizationEx Class
   [Expand]PivotGridOptionsFilterPopup Class
   [Expand]PivotGridOptionsHint Class
   [Expand]PivotGridOptionsMenu Class
   [Expand]PivotGridOptionsView Class
    PivotGridScrolling Enumeration
   [Expand]PivotGridStyleFormatCondition Class
    PivotGridValueHitTest Enumeration
   [Expand]PivotGroupEventArgs Class
    PivotGroupEventHandler Delegate
   [Expand]PivotLeftTopCellChangedEventArgs Class
   [Expand]PivotOlapExceptionEventArgs Class
    PivotOlapExceptionEventHandler Delegate
   [Expand]PivotQueryExceptionEventArgs Class
    PivotQueryExceptionEventHandler Delegate
    PivotShowButtonModeEnum Enumeration
   [Expand]PivotUserActionEventArgs Class
    PivotUserActionEventHandler Delegate
   [Expand]PivotXlsExportOptions Class
   [Expand]PivotXlsxExportOptions Class
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
   [Expand]Prefilter Class
    UserAction Enumeration
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

PivotGridControl.SaveCollapsedStateToFile Method

Saves the collapsed state of field values to the specified file.

Namespace:DevExpress.XtraPivotGrid
Assembly:DevExpress.XtraPivotGrid.v17.2.dll

Expanded Syntax

Parameters

path
Type: String
A System.String value which specifies the path to the file to which the collapsed state of field values is saved. If the specified file doesn't exist, it is created.

Expanded Remarks

The saved settings can then be restored using the LoadCollapsedStateFromFile method.

Note

The collapsed states for server mode and regular data sources are stored in different formats and not compatible with each other. Some issues can appear on restoring the collapsed state from different data source modes.

Expanded Example

Show Me

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E20014.

Field values' collapsed states can be restored only in the same layout they have been saved in. This example shows how to save and load a control's layout together with collapsed states to ensure that the states are loaded in the appropriate layout.

This example displays a pivot grid control and three buttons: Save, Load and Clear. When the Save button is clicked, the control layout and field values' collapsed states are saved to streams via the SaveLayoutToStream and SaveCollapsedStateToStream methods, respectively. On the Load button click, the RestoreLayoutFromStream method is firstly called to restore the layout, and then the collapsed states are loaded using the LoadCollapsedStateFromStream method. This ensures that even if you remove all fields from the pivot grid via the Clear button, the control's state will be restored when you click the Load button.

Expanded See Also

How would you rate this topic?​​​​​​​