Spread Windows Forms 6.0 Product Documentation
Cancel Property
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > ErrorEventArgs Class : Cancel Property


Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Property Cancel As Boolean
Visual Basic (Usage)Copy Code
Dim instance As ErrorEventArgs
Dim value As Boolean
 
instance.Cancel = value
 
value = instance.Cancel
C# 
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.
C#Copy Code
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 BasicCopy Code
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 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.