CellConsumerInitEventArgs Class

NOTE: This API is now obsolete.

Identifies the initial argument structure for design time creation. These arguments are passed to the connected Web Part as part of the CellConsumerInit event to tell the connected Web Part what the name and display name of the cell is.

Inheritance Hierarchy

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

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 CellConsumerInitEventArgs _
    Inherits InitEventArgs
'Usage
Dim instance As CellConsumerInitEventArgs

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

Examples

The following code example shows an overridden PartCommunicationInit method that creates a CellConsumerInitEventArgs object, sets the FieldName and FieldDisplayName properties, and then fires the CellConsumerInit event. This code example is part of a larger example provided for the ICellConsumer interface.

' Step #10: 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 CellConsumerInitEventArgs structure for the 
        ' CellConsumerInit event.
        Dim cellConsumerInitArgs As New CellConsumerInitEventArgs()

        ' Set the FieldName and FieldDisplayName values.
        cellConsumerInitArgs.FieldName = _cellName
        cellConsumerInitArgs.FieldDisplayName = _cellDisplayName

        ' Fire the CellConsumerInit event.
        RaiseEvent CellConsumerInit(Me, cellConsumerInitArgs)
    End If
End Sub

// Step #10: 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 CellConsumerInit event.
        if (CellConsumerInit != null)
        {
            // Create the CellConsumerInitEventArgs structure for the 
            // CellConsumerInit event.
            CellConsumerInitEventArgs cellConsumerInitArgs = 
                new CellConsumerInitEventArgs();
            
            // Set the FieldName and FieldDisplayName values.
            cellConsumerInitArgs.FieldName = _cellName;
            cellConsumerInitArgs.FieldDisplayName = _cellDisplayName;

            // Fire the CellConsumerInit event.
            CellConsumerInit(this, cellConsumerInitArgs);
        }
    }
}

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

CellConsumerInitEventArgs Members

Microsoft.SharePoint.WebPartPages.Communication Namespace