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.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
   [Expand]FieldValueCell Class
    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]PivotGridAppearances Class
   [Expand]PivotGridAppearancesBase Class
   [Expand]PivotGridAppearancesPrint Class
   [Expand]PivotGridCells Class
   [Collapse]PivotGridControl Class
     PivotGridControl Members
     PivotGridControl Constructor
    [Expand]PivotGridControl Properties
    [Collapse]PivotGridControl Events
      AsyncOperationCompleted Event
      AsyncOperationStarting Event
      BeforeLoadLayout Event
      BeginRefresh Event
      CellClick Event
      CellDoubleClick Event
      CellSelectionChanged Event
      CustomAppearance Event
      CustomCellDisplayText Event
      CustomCellEdit Event
      CustomCellEditForEditing Event
      CustomCellValue Event
      CustomChartDataSourceData Event
      CustomChartDataSourceRows Event
      CustomColumnWidth Event
      CustomCustomizationFormSort Event
      CustomDrawCell Event
      CustomDrawEmptyArea Event
      CustomDrawFieldHeader Event
      CustomDrawFieldHeaderArea Event
      CustomDrawFieldValue Event
      CustomEditValue Event
      CustomExportCell Event
      CustomExportFieldValue Event
      CustomExportHeader Event
      CustomFieldSort Event
      CustomFieldValueCells Event
      CustomFilterPopupItems Event
      CustomGroupInterval Event
      CustomRowHeight Event
      CustomServerModeSort Event
      CustomSummary Event
      CustomUnboundFieldData Event
      DataSourceChanged Event
      EditValueChanged Event
      EndRefresh Event
      ExportFinished Event
      ExportStarted Event
      FieldAreaChanged Event
      FieldAreaChanging Event
      FieldAreaIndexChanged Event
      FieldExpandedInFieldGroupChanged Event
      FieldFilterChanged Event
      FieldFilterChanging Event
      FieldPropertyChanged Event
      FieldTooltipShowing Event
      FieldUnboundExpressionChanged Event
      FieldValueCollapsed Event
      FieldValueCollapsing Event
      FieldValueDisplayText Event
      FieldValueExpanded Event
      FieldValueExpanding Event
      FieldValueImageIndex Event
      FieldValueNotExpanded Event
      FieldVisibleChanged Event
      FieldWidthChanged Event
      FocusedCellChanged Event
      GridLayout Event
      GroupFilterChanged Event
      HiddenEditor Event
      HideCustomizationForm Event
      InvalidValueException Event
      LayoutUpgrade Event
      LeftTopCellChanged Event
      MenuItemClick Event
      OLAPException Event
      OLAPQueryTimeout Event
      PopupMenuShowing Event
      PrefilterCriteriaChanged Event
      QueryException Event
      ShowCustomizationForm Event
      ShowingCustomizationForm Event
      ShowingEditor Event
      ShownEditor Event
      UserActionChanged Event
      ValidatingEditor Event
    [Expand]PivotGridControl Methods
   [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]PivotGridFieldOptionsEx 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]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]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

PivotGridControl.LayoutUpgrade Event

Occurs when a layout is restored from a data store (a stream, xml file or the system registry) and its version is different than that of the control's current layout version.

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

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type LayoutUpgradeEventArgs containing data related to this event.

The following LayoutUpgradeEventArgs properties provide information specific to this event.
Property Description
NewHiddenItems Returns an array of items that exist in the current control but do not exist in the layout being loaded. These items are hidden. This property is in effect for the LayoutControl.
PreviousVersion Returns the textual representation of the previous layout version.

Expanded Remarks

This event lets you customize the control's layout immediately after an earlier version of the control's layout has been loaded from a data store (a stream, xml file or the system registry). For instance, the layout being loaded has overridden specific filtering or sorting settings of the new layout. So the LayoutUpgrade event can be handled to restore layout settings specific to the new layout.

To enable the LayoutUpgrade event to be called you need to assign different versions to different layouts via the DevExpress.Utils.OptionsLayoutBase.LayoutVersion property of the OptionsLayout object.

Consider an example. When the first version of an application was released the version of the control's layout was not specified (it was set to an empty string, by default). While running this application an end-user hid specific fields and saved the layout, say, to an XML file. Then a new version of the application was designed (for instance, it added new fields and data could be filtered against any of these fields). At design time the new layout in the new application should be assigned a specific version (say, "1.1"). In this case, when an end-user runs the new application and loads the previously saved layout from the XML file the LayoutUpgrade event will be fired since the versions of the current layout ("1.1") and the layout being loaded ("") won't match. In the LayoutUpgrade event handler you can specify the positions of the newly added fields and restore the filter settings of these fields, if required.

If the versions of the current layout and the layout being loaded match, the LayoutUpgrade event will not fire.

The OptionsLayout property provides multiple settings which control how the layout is restored from the data store. It also specifies which settings should be stored when the layout is saved to the data store.

The BeforeLoadLayout event can be handled to prevent a layout from being loaded from a data store.

Expanded See Also

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