CellReadyEventArgs Class
NOTE: This API is now obsolete.
Provides the current cell value from a Web Part that implements the ICellProvider interface when the CellReady event occurs.
Inheritance Hierarchy
System.Object
System.EventArgs
Microsoft.SharePoint.WebPartPages.Communication.CellReadyEventArgs
Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Class CellReadyEventArgs _
Inherits EventArgs
Dim instance As CellReadyEventArgs
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public class CellReadyEventArgs : EventArgs
Examples
The following code example shows an overridden WebPart.PartCommunicationMainmethod that creates a CellReadyEventArgs data structure to contain the Cell property value, sets the property value, and then fires the CellReady event. This code example is part of a larger example provided for the ICellProvider interface.
' Step #10: Override the PartCommunicationMain() method.
' The PartCommunicationMain method is called by the Web Part
' infrastructure on the client during
' the ASP.NET PreRender event to allow the part to pass its primary
' data to the other connected parts.
' It is important to always fire the CellReady event. Some parts
' may not behave properly if they are left waiting for this
' information.
Public Overrides Sub PartCommunicationMain()
' Check if connected.
If _connected Then
' If there is a listener, fire the CellReady event.
If Not (CellReady Is Nothing) Then
' Create the CellReadyEventArgs data structure for the CellProviderInit event.
Dim cellReadyArgs As New CellReadyEventArgs()
' If the user clicked the button, then send the value.
If _cellClicked Then
' Set the cell to the value of the TextBox text.
' This is the value that will be sent to the Consumer
cellReadyArgs.Cell = _cellInput.Text
Else
' The user didn't actually click the button
' so just send an empty string to the consumer.
cellReadyArgs.Cell = ""
End If
' Fire the CellReady event.
' The Consumer will receive the cell value in its CellReady
' event handler
RaiseEvent CellReady(Me, cellReadyArgs)
End If
End If
End Sub
// Step #10: Override the PartCommunicationMain() method.
// The PartCommunicationMain method is called by the Web Part
// infrastructure on the client during
// the ASP.NET PreRender event to allow the part to pass its
// primary data to the other connected parts.
// It is important to always fire the CellReady event. Some
// parts may not behave properly if they are left waiting for
// this information.
public override void PartCommunicationMain()
{
// Check if connected.
if(_connected)
{
// If there is a listener, fire the CellReady event.
if (CellReady != null)
{
// Create the CellReadyEventArgs data structure for
// the CellProviderInit event.
CellReadyEventArgs cellReadyArgs = new CellReadyEventArgs();
// If the user clicked the button, then send the
// value.
if (_cellClicked)
{
// Set the cell to the value of the TextBox
// text.
// This is the value that will be sent to the
// Consumer
cellReadyArgs.Cell = _cellInput.Text;
}
else
{
// The user didn't actually click the button
// so just send an empty string to the
// consumer.
cellReadyArgs.Cell = "";
}
// Fire the CellReady event.
// The Consumer will receive the cell value in its
// CellReady event handler
CellReady(this, cellReadyArgs);
}
}
}
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.