SPEventPropertiesBase.Cancel property

NOTE: This API is now obsolete.

Gets or sets a Boolean value that indicates whether to cancel the event.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<ObsoleteAttribute("Use Status")> _
Public Property Cancel As Boolean
    Get
    Set
'Usage
Dim instance As SPEventPropertiesBase
Dim value As Boolean

value = instance.Cancel

instance.Cancel = value
[ObsoleteAttribute("Use Status")]
public bool Cancel { get; set; }

Property value

Type: System.Boolean
true to cancel the event; otherwise, false.

Remarks

This is a deprecated property and should not be used. Instead, use the Status property to cancel an event. A true value is equivalent to setting Status to CancelWithError. A false value is equivalent to setting Status to Continue.

See also

Reference

SPEventPropertiesBase class

SPEventPropertiesBase members

Microsoft.SharePoint namespace