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

Requirements

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

Reference

ActiveSheetChangingEventArgs Class
ActiveSheetChangingEventArgs Members