Cancel Property (ErrorEventArgs)

Gets or sets whether to cancel default processing and throw exceptions or EditError event.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Cancel As Boolean

'Usage
 
Dim instance As ErrorEventArgs
Dim value As Boolean
 
instance.Cancel = value
 
value = instance.Cancel

public bool Cancel {get; set;}

Property Value

Boolean: true if exceptions or the EditError event should be thrown; false otherwise

Example

This example displays an error message.

void fpSpread1Error(object sender, ErrorEventArgs e)
{
      if ((e.EditError == FarPoint.Win.Spread.EditError.InvalidCellData))
      {
            if ((e.IsEditError == true))
            {
                  e.Cancel = true;
                  MessageBox.Show(e.ErrorMessage);
                  e.View.Sheets[0].Cells[e.Row, e.Column].BackColor = Color.Red;
            }
      }
}

Visual Basic

Private Sub FpSpread1Error(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.ErrorEventArgs) Handles FpSpread1.Error
      If e.EditError = Win.Spread.EditError.InvalidCellData Then
            If e.IsEditError = True Then
                  e.Cancel = True
                  MessageBox.Show(e.ErrorMessage)
                  e.View.Sheets(0).Cells(e.Row, e.Column).BackColor = Color.Red
            End If
      End If
End Sub

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

ErrorEventArgs Class
ErrorEventArgs Members