SpreadsheetCellCancelEventArgs Class

Provides data for the SpreadsheetControl.CellBeginEdit event and serves as the base class for SpreadsheetCellValidatingEventArgs.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

C#

[ComVisible(true)]
public class SpreadsheetCellCancelEventArgs :
    SpreadsheetCellEventArgsBase

VB.NET

<ComVisible(True)>
Public Class SpreadsheetCellCancelEventArgs
    Inherits SpreadsheetCellEventArgsBase

Related API Members

SpreadsheetCellCancelEventArgs is the data class for the following events:

Library	Related API Members
WinForms Controls	SpreadsheetControl.CellBeginEdit
WPF Controls	SpreadsheetControl.CellBeginEdit

Remarks

The SpreadsheetCellCancelEventArgs class introduces the SpreadsheetCellCancelEventArgs.Cancel property which specifies whether the operation performed on the processed event should be canceled. Set this property to true to cancel activation of the cell editor when handling the SpreadsheetControl.CellBeginEdit event, or to cancel closing the cell editor when handling the SpreadsheetControl.CellEndEdit event.

An instance of the SpreadsheetCellCancelEventArgs class with appropriate settings is automatically created and passed to the corresponding event’s handler.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SpreadsheetCellCancelEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/CS/SpreadsheetCustomization/Form1.cs#L101

void spreadsheetControl1_CellBeginEdit(object sender, DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs e)
{

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/CS/SpreadsheetCustomization/Form1.cs#L83

void spreadsheetControl1_CellBeginEdit(object sender, DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs e) {
    // Access the active cell.

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/CS/WindowsFormsApplication1/FormatPainterProvider.cs#L92

private void spreadsheetControl1_CellBeginEdit(object sender, DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs e)
{

how-to-edit-rich-text-in-spreadsheetcontrol/CS/SpreadsheetRichText/Form1.cs#L31

private void spreadsheetControl_CellBeginEdit(object sender, DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs e)
{

VB.NET

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/VB/SpreadsheetCustomization/Form1.vb#L94

Private Sub spreadsheetControl1_CellBeginEdit(ByVal sender As Object, ByVal e As DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs)
    ' Disable editing of the "Category" column's cells to prevent end-users from entering wrong values.

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/VB/SpreadsheetCustomization/Form1.vb#L86

Private Sub spreadsheetControl1_CellBeginEdit(ByVal sender As Object, ByVal e As DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs)
    ' Access the active cell.

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/VB/WindowsFormsApplication1/FormatPainterProvider.vb#L90

Private Sub spreadsheetControl1_CellBeginEdit(ByVal sender As Object, ByVal e As DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs)
    If IsFormatPainterActivated() Then

how-to-edit-rich-text-in-spreadsheetcontrol/VB/SpreadsheetRichText/Form1.vb#L28

Private Sub spreadsheetControl_CellBeginEdit(sender As Object, e As DevExpress.XtraSpreadsheet.SpreadsheetCellCancelEventArgs) Handles spreadsheetControl.CellBeginEdit
    If e.Cell.HasRichText Then

Inheritance

Object

EventArgs

SpreadsheetCellEventArgsBase

SpreadsheetCellCancelEventArgs

SpreadsheetCellValidatingEventArgs