Cancel Property (AdvanceEventArgs)

Gets or sets whether to cancel default processing.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Cancel As Boolean

'Usage
 
Dim instance As AdvanceEventArgs
Dim value As Boolean
 
instance.Cancel = value
 
value = instance.Cancel

public bool Cancel {get; set;}

Property Value

Boolean: true if cancelled; false otherwise

Remarks

By default, focus will not move to the previous or next control. Set Cancel to false or set the focus to move to the next control.

Example

This example shows the use of the property by popping up a message box if the user clicks in the last cell of the spreadsheet and presses the Tab key to move to the next control on the form.

private void fpSpread1_Advance(object sender, FarPoint.Win.Spread.AdvanceEventArgs e)
{
    if (e.AdvanceNext == true)
    {
        MessageBox.Show("We're going to the next control!!");
    }
    else
        e.Cancel = false;
}

Visual Basic

Private Sub FpSpread1_Advance(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.AdvanceEventArgs) Handles FpSpread1.Advance
    If e.AdvanceNext = True Then
          MessageBox.Show("We're going to the next control!!")
    Else
          e.Cancel = False
    End If
End Sub

Requirements

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

Reference

AdvanceEventArgs Class
AdvanceEventArgs Members