Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
CellReadyEventArgs Class
Collapse the table of content
Expand the table of content

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.


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

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public class CellReadyEventArgs : EventArgs

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 override void PartCommunicationMain()
            // Check 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;
                        // 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);

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft