Share via


SPList.EventSinkData Property

NOTE: This API is now obsolete.

Gets or sets an arbitrary string for use by a Windows SharePoint Services 2.0 event handler for document library events.

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

Syntax

'Declaration
<ObsoleteAttribute("Use V3 style events")> _
Public Property EventSinkData As String
    Get
    Set
'Usage
Dim instance As SPList
Dim value As String

value = instance.EventSinkData

instance.EventSinkData = value
[ObsoleteAttribute("Use V3 style events")]
public string EventSinkData { get; set; }

Property Value

Type: System.String
A string for use by an event handler. This property setting does not affect Windows SharePoint Services 3.0 events.

Remarks

The EventSinkData property only applies to a document library or to a list derived from a document library and contains the data that is specified in the user interface when the event handler is bound to the list. This property returns a NotSupportedException exception if the list is neither a document library nor a list derived from a document library.

For more information about this property and about document library events, seeWalkthrough: Handling Document Library Events.

See Also

Reference

SPList Class

SPList Members

Microsoft.SharePoint Namespace