Partilhar via


CellReadyEventArgs.Cell Property

NOTE: This API is now obsolete.

Gets or sets the cell's data when the CellReady event of the ICellProvider interface occurs.

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

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public Property Cell As Object
    Get
    Set
'Usage
Dim instance As CellReadyEventArgs
Dim value As Object

value = instance.Cell

instance.Cell = value
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public Object Cell { get; set; }

Property Value

Type: System.Object
The cell data.

Examples

The following code example shows an overridden PartCommunicationMain method 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);
                }
            }
        }

See Also

Reference

CellReadyEventArgs Class

CellReadyEventArgs Members

Microsoft.SharePoint.WebPartPages.Communication Namespace