Share via


ICellProvider.CellProviderInit Event

NOTE: This API is now obsolete.

Provides FieldName and FieldDisplayName property values to a Web Part that implements the ICellConsumer interface.

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

Syntax

<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Event CellProviderInit As CellProviderInitEventHandler

Dim instance As ICellProvider
Dim handler As CellProviderInitEventHandler

AddHandler instance.CellProviderInit, handler
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
event CellProviderInitEventHandler CellProviderInit

Examples

The following code example shows an overridden WebPart.PartCommunicationInitmethod that creates a CellProviderInitEventArgs data structure to contain the FieldName and FieldDisplayName property values, sets the property values, and then fires the CellProviderInit event. This code example is part of a larger example provided for the ICellProvider interface.

      ' Step #9: Override the PartCommunicationInit() method
      ' PartCommunicationInit() is called by the Web Part 
      ' infrastructure during the ASP.Net PreRender 
      ' event to allow the part to pass initialization information to 
      ' the other connected parts.
      ' It is important to always pass initialization information as 
      ' some parts
      ' may not behave properly if this initialization information is 
      ' not received.
      Public Overrides Sub PartCommunicationInit()
        ' Check if connected
         If _connected Then                                
           ' Create the InitEventArgs structure for the 
           ' CellProviderInit event.
            Dim cellProviderInitArgs As New CellProviderInitEventArgs()

            ' Set the FieldName and FieldDisplay values.
             cellProviderInitArgs.FieldName = _cellName
             cellProviderInitArgs.FieldDisplayName = _cellDisplayName

            ' Fire the CellProviderInit event. 
            RaiseEvent CellProviderInit(Me, cellProviderInitArgs)

          End If
      End Sub
        // Step #9: Override the PartCommunicationInit() method
        // PartCommunicationInit() is called by the Web Part 
        // infrastructure during the ASP.Net PreRender 
        // event to allow the part to pass initialization information 
        // to the other connected parts.
        // It is important to always pass initialization information as 
        // some parts may not behave properly if this initialization 
        // information is not received.
        public override void PartCommunicationInit()
        {
            // Check if connected
            if(_connected)
            {
                // If there is a listener, fire the CellProviderInit 
                // event.
                if (CellProviderInit != null)
                {
                    // Create the InitEventArgs structure for the 
                    // CellProviderInit event.
                    CellProviderInitEventArgs cellProviderInitArgs = 
                       new CellProviderInitEventArgs();
                    
                    // Set the FieldName and FieldDisplay values.
                    cellProviderInitArgs.FieldName = _cellName;
                    cellProviderInitArgs.FieldDisplayName = 
                       _cellDisplayName;
                    
                    // Fire the CellProviderInit event.
                    CellProviderInit(this, cellProviderInitArgs);
                }
            }
        }

See Also

Reference

ICellProvider Interface

ICellProvider Members

Microsoft.SharePoint.WebPartPages.Communication Namespace