CellReadyEventHandler delegate

NOTE: This API is now obsolete.

Represents the method that will handle the CellReady event fired by a Web Part that implements the ICellProvider interface.

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

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Delegate Sub CellReadyEventHandler ( _
    sender As Object, _
    e As CellReadyEventArgs _
)
'Usage
Dim instance As New CellReadyEventHandler(AddressOf HandlerMethod)
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public delegate void CellReadyEventHandler(
    Object sender,
    CellReadyEventArgs e
)

Parameters

  • sender
    Type: System.Object

    The source of the event, the Web Part.

Remarks

When you create a CellReadyEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate.

Examples

The following code example shows the declaration of an event of type CellReadyEventHandler from a Microsoft.SharePoint.WebPartPages.WebPart class implements the ICellProvider interface. A code sample that shows the implementation of the event handler is in the CellReady event topic. A code sample that shows the full implementation of the ICellProvider interface is in the ICellProvider topic.

' Step #3: Declare the ICellProvider events.
' Because this class implements the ICellProvider interface, it must 
' implement the interface member events CellProviderInit and CellReady.
Public Event CellProviderInit As CellProviderInitEventHandler Implements ICellProvider.CellProviderInit
Public Event CellReady As CellReadyEventHandler Implements ICellProvider.CellReady
// Step #3: Declare the ICellProvider events.
// Because this class implements the ICellProvider interface, it must 
// implement the interface member events CellProviderInit and 
// CellReady.
public event CellProviderInitEventHandler CellProviderInit;    
public event CellReadyEventHandler CellReady;

See also

Reference

Microsoft.SharePoint.WebPartPages.Communication namespace