Spread Windows Forms 13.0 Product Documentation
FarPoint.Win.Spread Assembly / FarPoint.Win.Spread Namespace / ActiveSheetChangingEventArgs Class / Cancel Property
Example


In This Topic
    Cancel Property (ActiveSheetChangingEventArgs)
    In This Topic
    Gets or sets whether to cancel the active sheet change.
    Syntax
    '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;
         }
    }
    
    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
    
    See Also