[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand].NET Core 3 Support
 [Expand]Common Concepts
 [Expand]MVVM Framework
 [Expand]Controls and Libraries
 [Expand]Scaffolding Wizard
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [Expand]DevExpress.Data
  [Expand]DevExpress.Mvvm.UI
  [Expand]DevExpress.Mvvm.UI.Interactivity
  [Expand]DevExpress.Mvvm.UI.ModuleInjection
  [Expand]DevExpress.Xpf.Accordion
  [Expand]DevExpress.Xpf.Bars
  [Expand]DevExpress.Xpf.Carousel
  [Expand]DevExpress.Xpf.Charts
  [Expand]DevExpress.Xpf.Charts.Localization
  [Expand]DevExpress.Xpf.Charts.RangeControlClient
  [Expand]DevExpress.Xpf.ChunkList
  [Expand]DevExpress.Xpf.Controls
  [Expand]DevExpress.Xpf.Core
  [Expand]DevExpress.Xpf.Core.ConditionalFormatting
  [Expand]DevExpress.Xpf.Core.DataSources
  [Expand]DevExpress.Xpf.Core.FilteringUI
  [Expand]DevExpress.Xpf.Core.Native
  [Expand]DevExpress.Xpf.Core.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Dialogs
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.DXBinding
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DataPager
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor.Native
  [Expand]DevExpress.Xpf.Editors.Filtering
  [Expand]DevExpress.Xpf.Editors.Flyout
  [Expand]DevExpress.Xpf.Editors.Flyout.Native
  [Expand]DevExpress.Xpf.Editors.Helpers
  [Expand]DevExpress.Xpf.Editors.Native
  [Expand]DevExpress.Xpf.Editors.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [Expand]DevExpress.Xpf.ExpressionEditor
  [Expand]DevExpress.Xpf.Gantt
  [Expand]DevExpress.Xpf.Gauges
  [Expand]DevExpress.Xpf.Gauges.Localization
  [Expand]DevExpress.Xpf.Grid
  [Expand]DevExpress.Xpf.Grid.ConditionalFormatting
  [Expand]DevExpress.Xpf.Grid.LookUp
  [Expand]DevExpress.Xpf.Grid.TreeList
  [Expand]DevExpress.Xpf.Layout.Core
  [Expand]DevExpress.Xpf.LayoutControl
  [Expand]DevExpress.Xpf.Map
  [Expand]DevExpress.Xpf.NavBar
  [Expand]DevExpress.Xpf.Navigation
  [Expand]DevExpress.Xpf.PdfViewer
  [Expand]DevExpress.Xpf.PivotGrid
  [Expand]DevExpress.Xpf.PivotGrid.Printing
  [Expand]DevExpress.Xpf.Printing
  [Expand]DevExpress.Xpf.Printing.Parameters
  [Expand]DevExpress.Xpf.Printing.Parameters.Models
  [Expand]DevExpress.Xpf.Printing.PreviewControl
  [Expand]DevExpress.Xpf.Printing.PreviewControl.Bars
  [Expand]DevExpress.Xpf.Prism
  [Expand]DevExpress.Xpf.PropertyGrid
  [Expand]DevExpress.Xpf.Reports.UserDesigner
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Extensions
  [Expand]DevExpress.Xpf.Reports.UserDesigner.Localization
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard
  [Expand]DevExpress.Xpf.Reports.UserDesigner.ReportWizard.Pages
  [Expand]DevExpress.Xpf.Ribbon
  [Expand]DevExpress.Xpf.RichEdit
  [Expand]DevExpress.Xpf.RichEdit.Menu
  [Expand]DevExpress.Xpf.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.Scheduling
  [Expand]DevExpress.Xpf.Scheduling.Common
  [Expand]DevExpress.Xpf.Scheduling.Editors
  [Expand]DevExpress.Xpf.Scheduling.iCalendar
  [Expand]DevExpress.Xpf.Scheduling.Reporting
  [Expand]DevExpress.Xpf.Scheduling.Visual
  [Expand]DevExpress.Xpf.Scheduling.VisualData
  [Expand]DevExpress.Xpf.SpellChecker
  [Collapse]DevExpress.Xpf.Spreadsheet
   [Expand]CellData Class
    CommandBarStyle Enumeration
    NameBoxItemDisplayMode Enumeration
    ShowCellToolTipMode Enumeration
   [Expand]SpreadsheetAxisLabelOverlappingOptions Class
   [Expand]SpreadsheetBehaviorOptions Class
   [Expand]SpreadsheetCapabilitiesOptions Class
   [Expand]SpreadsheetCellOptions Class
   [Expand]SpreadsheetClipboardOptions Class
   [Expand]SpreadsheetColumnBehaviorOptions Class
   [Expand]SpreadsheetCommentBehaviorOptions Class
   [Collapse]SpreadsheetControl Class
     SpreadsheetControl Members
     SpreadsheetControl Constructor
    [Expand]SpreadsheetControl Properties
    [Expand]SpreadsheetControl Events
    [Collapse]SpreadsheetControl Methods
     [Expand]AddService Method
      AssignShortcutKeyToCommand Method
      BeginInvoke Method
      BeginUpdate Method
      CancelUpdate Method
      CircleInvalidData Method
      ClearValidationCircles Method
      CloseCellEditor Method
      CreateCommand Method
      CreateNewDocument Method
      Dispose Method
      EndUpdate Method
     [Expand]ExportToHtml Method
     [Expand]ExportToPdf Method
      GetCellBounds Method
      GetCellFromPoint Method
      GetCommand Method
      GetSelectedRanges Method
      GetSelectedShapes Method
      GetService Method
      GetService<T> Method
      GetSpreadsheet Method
      GetUseDefaultSvgImages Method
     [Expand]LoadDocument Method
      OnApplyTemplate Method
      OnStatusBarPopupMenuOpening Method
      OpenCellEditor Method
     [Expand]Print Method
     [Expand]RemoveService Method
      RemoveShortcutKey Method
      ReplaceService<T> Method
      ResetLayout Method
     [Expand]SaveDocument Method
     [Expand]SaveDocumentAs Method
     [Expand]SetSelectedRanges Method
      SetSelectedShapes Method
      SetSpreadsheet Method
      SetUseDefaultSvgImages Method
      ShowPrintDialog Method
      ShowPrintPreview Method
      ShowRibbonPrintPreview Method
      UpdateCommandUI Method
   [Expand]SpreadsheetControlOptions Class
   [Expand]SpreadsheetCopyOptions Class
   [Expand]SpreadsheetCsvExportOptions Class
   [Expand]SpreadsheetCsvImportOptions Class
   [Expand]SpreadsheetCustomCellEditEventArgs Class
    SpreadsheetCustomCellEditEventHandler Delegate
   [Expand]SpreadsheetDataValidationBehaviorOptions Class
   [Expand]SpreadsheetDocumentSource Class
   [Expand]SpreadsheetDrawingBehaviorOptions Class
    SpreadsheetElementVisibility Enumeration
   [Expand]SpreadsheetExportOptions Class
   [Expand]SpreadsheetFormulaAutoCompleteOptions Class
    SpreadsheetFormulaAutoCompleteSearchMode Enumeration
   [Expand]SpreadsheetFormulaBarControl Class
   [Expand]SpreadsheetGroupBehaviorOptions Class
   [Expand]SpreadsheetImportOptions Class
    SpreadsheetMenuType Enumeration
   [Expand]SpreadsheetOpenXmlImportOptions Class
   [Expand]SpreadsheetPivotTableFieldListOptions Class
    SpreadsheetPivotTableFieldListStartPosition Enumeration
   [Expand]SpreadsheetProtectionBehaviorOptions Class
   [Expand]SpreadsheetRealTimeDataOptions Class
   [Expand]SpreadsheetRowBehaviorOptions Class
   [Expand]SpreadsheetSaveOptions Class
   [Expand]SpreadsheetSelectionBehaviorOptions Class
   [Expand]SpreadsheetTxtExportOptions Class
   [Expand]SpreadsheetTxtImportOptions Class
   [Expand]SpreadsheetViewOptions Class
   [Expand]SpreadsheetWorksheetBehaviorOptions Class
   [Expand]SpreadsheetXlsImportOptions Class
   [Expand]SpreadsheetXlsmImportOptions Class
   [Expand]WorksheetDisplayArea Class
  [Expand]DevExpress.Xpf.Spreadsheet.Menu
  [Expand]DevExpress.Xpf.TreeMap
  [Expand]DevExpress.Xpf.Utils.Themes
  [Expand]DevExpress.Xpf.WindowsUI
  [Expand]DevExpress.Xpf.WindowsUI.Internal
  [Expand]DevExpress.Xpf.WindowsUI.Navigation
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Printing
[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.CloseCellEditor Method

Closes the cell editor.

Namespace:DevExpress.Xpf.Spreadsheet
Assembly:DevExpress.Xpf.Spreadsheet.v19.2.dll

Expanded Syntax

Return value

Type: Boolean
true, if the cell editor is closed successfully; otherwise, false.

Expanded Remarks

Use the CloseCellEditor method to close the cell editor activated by an end-user to enter or edit a cell value. To check whether a cell editor is currently active, use the IsCellEditorActive property. The CloseCellEditor method's parameter specifies whether a value that has been entered or edited via the cell editor should be committed or rolled back when closing the editor.

The following table lists modes in which the cell editor can be closed, gives the CloseCellEditor method's parameter value that corresponds to each mode, a shortcut that closes the cell editor in each mode, and events that are raised in each mode.

Mode

Parameter

Shortcut

Events

Commit an entered cell value to an active cell.

DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.ActiveCell

ENTER

CellEndEdit

CellValueChanged

Commit an entered cell value to all cells that are currently selected.

DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.SelectedCells

CTRL+ENTER

CellEndEdit

CellValueChanged

Commit an entered formula to an active cell or selected cells as an array formula.

DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.ArrayFormula

CTRL+SHIFT+ENTER

CellEndEdit

CellValueChanged

Cancel an entry in the cell editor.

DevExpress.XtraSpreadsheet.CellEditorEnterValueMode.Cancel

ESC

CellCancelEdit

Note that you can specify when the CellValueChanged event should be raised after a cell value has been edited via the cell in-place editor and committed: each time, or only if a cell value has been changed. To do this, use the DevExpress.XtraSpreadsheet.SpreadsheetCellEditorBehaviorOptions.CommitMode property, accessible via the SpreadsheetControl.Options.Behavior.CellEditor.CommitMode notation.

Expanded See Also

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