ICellConsumer.CellConsumerInit Event
NOTE: This API is now obsolete.
An initialization event. This event handler is of type CellConsumerInitEventHandler.
Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Event CellConsumerInit As CellConsumerInitEventHandler
'Usage
Dim instance As ICellConsumer
Dim handler As CellConsumerInitEventHandler
AddHandler instance.CellConsumerInit, handler
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
event CellConsumerInitEventHandler CellConsumerInit
Examples
The following code example shows an overridden PartCommunicationInit method that creates the CellConsumerInitEventArgs object, sets its 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);
}
}
}