Cancel Property (ActiveSheetChangingEventArgs)

Gets or sets whether to cancel the active sheet change.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Cancel As Boolean

'Usage
 
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

Example

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.

private void fpSpread1_ActiveSheetChanging(object sender, FarPoint.Win.Spread.ActiveSheetChangingEventArgs e)
{
     if (e.ActivatedSheetIndex == 2)
     {
          e.Cancel = true;
     }
}

Visual Basic

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

Reference

ActiveSheetChangingEventArgs Class
ActiveSheetChangingEventArgs Members