[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
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [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.Behaviors
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.DragDrop
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Filtering
  [Expand]DevExpress.Utils.Layout
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.MVVM
  [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.Base
  [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.FluentDesignSystem
  [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.ToolbarForm
  [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.Docking
  [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.Converter
  [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.Extensions
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [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.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [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
  [Collapse]DevExpress.XtraSpreadsheet
   [Expand]CustomDrawCellBackgroundEventArgs Class
    CustomDrawCellBackgroundEventHandler Delegate
   [Expand]CustomDrawCellEventArgs Class
   [Expand]CustomDrawCellEventArgsBase Class
    CustomDrawCellEventHandler Delegate
   [Expand]CustomDrawColumnHeaderBackgroundEventArgs Class
    CustomDrawColumnHeaderBackgroundEventHandler Delegate
   [Expand]CustomDrawColumnHeaderEventArgs Class
    CustomDrawColumnHeaderEventHandler Delegate
   [Expand]CustomDrawCommentIndicatorEventArgs Class
    CustomDrawCommentIndicatorEventHandler Delegate
   [Expand]CustomDrawFrozenPaneBorderEventArgs Class
    CustomDrawFrozenPaneBorderEventHandler Delegate
   [Expand]CustomDrawHeaderEventArgsBase Class
   [Expand]CustomDrawObjectEventsArgs Class
   [Expand]CustomDrawRowHeaderBackgroundEventArgs Class
    CustomDrawRowHeaderBackgroundEventHandler Delegate
   [Expand]CustomDrawRowHeaderEventArgs Class
    CustomDrawRowHeaderEventHandler Delegate
    FrozenPaneBorderType Enumeration
    NameBoxItemDisplayMode Enumeration
   [Expand]PopupMenuShowingEventArgs Class
    PopupMenuShowingEventHandler Delegate
   [Collapse]SpreadsheetControl Class
     SpreadsheetControl Members
     SpreadsheetControl Constructor
    [Expand]SpreadsheetControl Properties
    [Collapse]SpreadsheetControl Events
      ActiveSheetChanged Event
      ActiveSheetChanging Event
      AfterDropRange Event
      AfterFillRange Event
      BeforeDispose Event
      BeforeDragRange Event
      BeforeDropRange Event
      BeforeExport Event
      BeforeFillRange Event
      BeforeImport Event
      BeforePrintSheet Event
      CellBeginEdit Event
      CellCancelEdit Event
      CellEndEdit Event
      CellValueChanged Event
      ClipboardDataObtained Event
      ClipboardDataPasted Event
      ClipboardDataPasting Event
      ColumnsInserted Event
      ColumnsInserting Event
      ColumnsRemoved Event
      ColumnsRemoving Event
      CommentInserted Event
      CommentInserting Event
      CommentRemoved Event
      CommentRemoving Event
      ContentChanged Event
      CopiedRangePasted Event
      CopiedRangePasting Event
      CustomAssemblyLoading Event
      CustomCellEdit Event
      CustomDrawCell Event
      CustomDrawCellBackground Event
      CustomDrawColumnHeader Event
      CustomDrawColumnHeaderBackground Event
      CustomDrawCommentIndicator Event
      CustomDrawFrozenPaneBorder Event
      CustomDrawRowHeader Event
      CustomDrawRowHeaderBackground Event
      DataBindingWarning Event
      DefinedNameConflictResolving Event
      DefinedNameDeleting Event
      DefinedNameEditing Event
      DefinedNameValidating Event
      DocumentClosing Event
      DocumentLoaded Event
      DocumentPropertiesChanged Event
      DocumentSaved Event
      EmptyDocumentCreated Event
      EncryptedFileIntegrityCheckFailed Event
      EncryptedFilePasswordCheckFailed Event
      EncryptedFilePasswordRequest Event
      HyperlinkClick Event
      InitializeDocument Event
      InvalidFormatException Event
      ModifiedChanged Event
      PanesFrozen Event
      PanesUnfrozen Event
      PopupMenuShowing Event
      PropertyChanged Event
      ProtectionWarning Event
      RangeCopied Event
      RangeCopying Event
      ReadOnlyChanged Event
      RowsInserted Event
      RowsInserting Event
      RowsRemoved Event
      RowsRemoving Event
      ScrollPositionChanged Event
      SelectionChanged Event
      ShapeInserted Event
      ShapeRemoved Event
      ShapeRemoving Event
      ShapesCopying Event
      SheetInserted Event
      SheetRemoved Event
      SheetRemoving Event
      SheetRenamed Event
      SheetRenaming Event
      UnhandledException Event
      UnitChanged Event
      UnitChanging Event
      UpdateUI Event
      ValidateCustomSqlQuery Event
      ZoomChanged Event
    [Expand]SpreadsheetControl Methods
   [Expand]SpreadsheetControlOptions Class
   [Expand]SpreadsheetCustomCellEditEventArgs Class
    SpreadsheetCustomCellEditEventHandler Delegate
   [Expand]SpreadsheetDataSourceWizardOptions Class
    SpreadsheetElementVisibility Enumeration
   [Expand]SpreadsheetFormulaBar Class
   [Expand]SpreadsheetFormulaBarControl Class
   [Expand]SpreadsheetHorizontalScrollbarOptions Class
    SpreadsheetMenuType Enumeration
   [Expand]SpreadsheetNameBoxControl Class
   [Expand]SpreadsheetScrollbarOptions Class
    SpreadsheetScrollbarVisibility Enumeration
   [Expand]SpreadsheetTabSelectorOptions Class
    SpreadsheetToolbarType Enumeration
   [Expand]SpreadsheetVerticalScrollbarOptions Class
   [Expand]WorksheetDisplayArea Class
  [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.XtraTreeMap.Printing
  [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]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

SpreadsheetControl.CellValueChanged Event

Occurs after the cell content was changed via the SpreadsheetControl UI.

Namespace:DevExpress.XtraSpreadsheet
Assembly:DevExpress.XtraSpreadsheet.v19.1.dll

Expanded Syntax

Expanded Event Data

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

Expanded Remarks

The CellValueChanged event can fire in the following cases:

  • When the cell content was modified via the in-place editor or formula bar. The Spreadsheet control closes the cell editor and commits the entered value to an active cell or selected cells when a user clicks outside the edited cell, presses ENTER, CTRL+ENTER or CTRL+SHIFT+ENTER, or the CloseCellEditor method is called with a parameter value other than DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.Cancel.

    You can specify when the CellValueChanged event should occur after a cell value was edited and committed to a cell: each time, or only if a cell value was changed. To do this, use the SpreadsheetControl.Options.Behavior.CellEditor.CommitMode property (DevExpress.XtraSpreadsheet.SpreadsheetCellEditorBehaviorOptions.CommitMode).

    Before the cell editor is opened, closed or canceled, the CellBeginEdit, CellEndEdit or CellCancelEdit event occurs, respectively. You can handle these events to perform any actions before a user activates the cell editor, commits or rolls back the entered value. For example, handle the CellBeginEdit event to prevent cell values from being modified via the cell editor, or handle the CellEndEdit event to validate cell values entered by users.

  • When a user pressed DELETE to clear the cell content.

  • When a new hyperlink was added to a cell via the Insert Hyperlink dialog, or an existing hyperlink was modified via the Edit Hyperlink dialog.

Note

The CellValueChanged event does not occur when a cell value was changed in code. Set the SpreadsheetControl.Options.Events.RaiseOnModificationsViaAPI property (DevExpress.XtraSpreadsheet.WorkbookEventOptions.RaiseOnModificationsViaAPI) to true to raise this event when changes are made in code.

The CellValueChanged event does not occur after a formula was recalculated and its result was changed, even if the recalculation was triggered in the SpreadsheetControl UI.

Expanded Example

The example below shows how to validate user input for a sample spreadsheet:

The following events are used to perform this task:

  • CellBeginEdit

    Handle this event to specify that a user can edit cells only in the "Unit Price" and "Units in Stock" columns.

  • CellEndEdit

    This event validates a value that a user enters into a cell. If the entered value is not a valid number, the Spreadsheet cancels the input and displays a warning.

  • CellValueChanged

    If a cell value in the "Units in Stock" column is equal to zero, the cell's background color changes to light pink.

Expanded See Also

Is this topic helpful?​​​​​​​