IAlertUpdateHandler.PreUpdate Method

Synchronous Before event that occurs when an alert is modified in the user interface.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Function PreUpdate ( _
    a As SPAlert, _
    web As SPWeb, _
    newAlert As Boolean, _
    properties As String _
) As Boolean
'Usage
Dim instance As IAlertUpdateHandler
Dim a As SPAlert
Dim web As SPWeb
Dim newAlert As Boolean
Dim properties As String
Dim returnValue As Boolean

returnValue = instance.PreUpdate(a, web, _
    newAlert, properties)
bool PreUpdate(
    SPAlert a,
    SPWeb web,
    bool newAlert,
    string properties
)

Parameters

  • newAlert
    Type: System.Boolean

    true if the alert being handled is new; otherwise, false.

  • properties
    Type: System.String

    A string containing properties of the alert.

Return Value

Type: System.Boolean
A Boolean value that can be used to prevent the update or to throw an SPException.

See Also

Reference

IAlertUpdateHandler Interface

IAlertUpdateHandler Members

Microsoft.SharePoint Namespace