Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Expand]WinForms Controls
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Collapse]WPF Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]Controls and Libraries
 [Expand]Localization
  Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Charts.Designer
  [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.ServerMode
  [Expand]DevExpress.Xpf.Data
  [Expand]DevExpress.Xpf.DataAccess
  [Expand]DevExpress.Xpf.DataAccess.DataSourceWizard
  [Expand]DevExpress.Xpf.Diagram
  [Expand]DevExpress.Xpf.Docking
  [Expand]DevExpress.Xpf.Docking.Base
  [Expand]DevExpress.Xpf.DocumentViewer
  [Expand]DevExpress.Xpf.Editors
  [Expand]DevExpress.Xpf.Editors.DateNavigator
  [Expand]DevExpress.Xpf.Editors.ExpressionEditor
  [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.Popups
  [Expand]DevExpress.Xpf.Editors.RangeControl
  [Expand]DevExpress.Xpf.Editors.Settings
  [Expand]DevExpress.Xpf.Editors.Validation
  [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.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.Scheduler
  [Expand]DevExpress.Xpf.Scheduler.Drawing
  [Expand]DevExpress.Xpf.Scheduler.Menu
  [Expand]DevExpress.Xpf.Scheduler.Reporting
  [Expand]DevExpress.Xpf.Scheduler.UI
  [Expand]DevExpress.Xpf.SpellChecker
  [Collapse]DevExpress.Xpf.Spreadsheet
   [Expand]CellData Class
    CommandBarStyle Enumeration
    ShowCellToolTipMode Enumeration
   [Expand]SpreadsheetAxisLabelOverlappingOptions Class
   [Expand]SpreadsheetBehaviorOptions Class
   [Expand]SpreadsheetCapabilitiesOptions Class
   [Expand]SpreadsheetCellOptions Class
   [Expand]SpreadsheetColumnBehaviorOptions Class
   [Expand]SpreadsheetCommentBehaviorOptions Class
   [Collapse]SpreadsheetControl Class
     SpreadsheetControl Members
     SpreadsheetControl Constructor
    [Expand]SpreadsheetControl Properties
    [Collapse]SpreadsheetControl Events
      ActiveSheetChanged Event
      ActiveSheetChanging Event
      BeforeDispose Event
      BeforeExport 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
      DefinedNameConflictResolving Event
      DefinedNameDeleting Event
      DefinedNameEditing Event
      DefinedNameValidating Event
      DocumentClosing Event
      DocumentLoaded Event
      DocumentPropertiesChanged Event
      EmptyDocumentCreated Event
      EncryptedFileIntegrityCheckFailed 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
      ZoomChanged Event
    [Expand]SpreadsheetControl Methods
   [Expand]SpreadsheetControlOptions Class
   [Expand]SpreadsheetCsvExportOptions Class
   [Expand]SpreadsheetCsvImportOptions Class
   [Expand]SpreadsheetCustomCellEditEventArgs Class
    SpreadsheetCustomCellEditEventHandler Delegate
   [Expand]SpreadsheetDocumentSource Class
   [Expand]SpreadsheetDrawingBehaviorOptions Class
    SpreadsheetElementVisibility Enumeration
   [Expand]SpreadsheetExportOptions Class
   [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.Navigation
  [Expand]DevExpress.XtraRichEdit
[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

SpreadsheetControl.CustomCellEdit Event

Allows you to assign a custom in-place editor to a cell.

Namespace:DevExpress.Xpf.Spreadsheet
Assembly:DevExpress.Xpf.Spreadsheet.v17.1.dll

Expanded Syntax

Expanded Event Data

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

The following SpreadsheetCustomCellEditEventArgs properties provide information specific to this event.
Property Description
Cell Gets the cell for which the event is fired.
ColumnIndex Gets the index of the column that contains the cell.
EditSettings Gets or sets an object that contains the custom cell editor's settings.
Formula Gets the formula that is currently contained in the cell.
FormulaInvariant Gets the formula in the invariant culture that is currently contained in the cell.
RowIndex Gets the index of the row that contains the cell.
SheetName Gets the name of the worksheet that contains the cell.
Value Gets the value currently contained in the cell.
ValueObject Gets a value associated with the DevExpress.Spreadsheet.CustomCellInplaceEditor object assigned to the cell.
Worksheet Gets the worksheet that contains the cell.

Expanded Remarks

The CustomCellEdit event fires when an end-user is about to start editing a cell and allows you to supply a custom editor from the DXEditors Library to the edited cell. Use the event’s Cell, ColumnIndex and RowIndex parameters to identify the currently edited cell. To provide an editor for editing a cell value, set the event's EditSettings parameter to the BaseEditSettings descendant containing settings specific to the required in-place editor. The Spreadsheet control uses information provided by the *EditSettings classes to create a fully-functional editor. Note that the actual editor is only created when an end-user starts to edit, and is automatically destroyed when editing is completed.

For details on how to embed custom in-place editors within worksheet cells, see the How to: Assign Custom In-place Editors to Worksheet Cells example.

Expanded See Also

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