Cancel Property (SelectionChangingEventArgs)

Gets or sets whether the selection action should be cancelled.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Cancel As Boolean

'Usage
 
Dim instance As SelectionChangingEventArgs
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 cancels the selection if the users tries to select only the first column.

private void fpSpread1SelectionChanging(object sender, FarPoint.Win.Spread.SelectionChangingEventArgs e) 
{
    if (e.CurrentColumn == 0)
    {
        e.Cancel = true;
    }
}

Visual Basic

Private Sub FpSpread1SelectionChanging(ByVal sender As Object, ByVal e As FarPoint.Win.Spread.SelectionChangingEventArgs)
Handles FpSpread1.SelectionChanging
    If e.CurrentColumn = 0 Then
        e.Cancel = True
    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

SelectionChangingEventArgs Class
SelectionChangingEventArgs Members