CellProviderInitEventArgs Class

NOTE: This API is now obsolete.

Holds the data structure that is initialized when an ICellProvider Web Part creates a connection and fires a CellConsumerInit event to an ICellConsumer interface. Cannot be inherited.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.SharePoint.WebPartPages.Communication.InitEventArgs
      Microsoft.SharePoint.WebPartPages.Communication.CellProviderInitEventArgs

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

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Public NotInheritable Class CellProviderInitEventArgs _
    Inherits InitEventArgs
'Usage
Dim instance As CellProviderInitEventArgs

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
public sealed class CellProviderInitEventArgs : InitEventArgs

Examples

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

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.

See Also

Reference

CellProviderInitEventArgs Members

Microsoft.SharePoint.WebPartPages.Communication Namespace