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

Glossary Item Box

Gets or sets whether to cancel the active sheet change.


Visual Basic (Declaration) 
Public Property Cancel As Boolean
Visual Basic (Usage)Copy Code
Dim instance As ActiveSheetChangingEventArgs
Dim value As Boolean
instance.Cancel = value
value = instance.Cancel
public bool Cancel {get; set;}

Property Value

Boolean: true if cancelled; false otherwise


This example shows the use of the property for a three-sheet workbook. In the ActiveSheetChanging event, if the third sheet is clicked, the event is cancelled and focus remains on the previous sheet.
C#Copy Code
private void fpSpread1_ActiveSheetChanging(object sender, FarPoint.Win.Spread.ActiveSheetChangingEventArgs e)
     if (e.ActivatedSheetIndex == 2)
          e.Cancel = true;
Visual BasicCopy Code
Private Sub FpSpread1_ActiveSheetChanging(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.ActiveSheetChangingEventArgs)
Handles FpSpread1.ActiveSheetChanging
   If e.ActivatedSheetIndex = 2 Then
      e.Cancel = True
   End If
End Sub


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.