IRowProvider.RowProviderInit Event
NOTE: This API is now obsolete.
Sends the names and display names of the fields in the provided row.
Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartRow instead")> _
Event RowProviderInit As RowProviderInitEventHandler
'Usage
Dim instance As IRowProvider
Dim handler As RowProviderInitEventHandler
AddHandler instance.RowProviderInit, handler
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartRow instead")]
event RowProviderInitEventHandler RowProviderInit
Remarks
The event handler receives an argument of type Microsoft.SharePoint.WebPartPages.Communication.RowProviderInitEventArgs containing data related to this event. The RowProviderInitEventArgs properties FieldList and FieldDisplayList provide information specific to this event.
Examples
The following code example shows an overridden WebPart.PartCommunicationInit method that creates a RowProviderInitEventArgsobject, sets field names and display names, and then fires the RowProviderInit event. This code example is part of a larger example provided for the IRowProvider interface.
' Step #7: Override the PartCommunicationInit() method.
' The PartCommunicationInit method 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. Some
' parts may not behave properly if this initialization
' information is not received.
Public Overrides Sub PartCommunicationInit()
' Ensure that all of the Web Part's controls are created.
EnsureChildControls()
' Check if connected.
If _connected Then
' Create the RowProviderInitEventArgs object for the
' RowProviderInit event.
Dim rowProviderInitEventArgs As New RowProviderInitEventArgs()
' Set the row field names.
rowProviderInitEventArgs.FieldList = _rowFieldNames
' Set the row field display names.
rowProviderInitEventArgs.FieldDisplayList = _rowFieldDisplayNames
' Fire the RowProviderInit event.
RaiseEvent RowProviderInit(Me, rowProviderInitEventArgs)
End If
End Sub
// Step #7: Override the PartCommunicationInit() method.
// The PartCommunicationInit method 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.
// Some parts may not behave properly if this initialization
// information is not received.
public override void PartCommunicationInit()
{
// Ensure that all of the Web Part's controls are created.
EnsureChildControls();
// Check if connected.
if(_connected)
{
// If there is a listener, fire the RowProviderInit
// event.
if (RowProviderInit != null)
{
// Create the RowProviderInitEventArgs object for
// the RowProviderInit event.
RowProviderInitEventArgs rowProviderInitEventArgs = new RowProviderInitEventArgs();
// Set the row field names.
rowProviderInitEventArgs.FieldList = _rowFieldNames;
// Set the row field display names.
rowProviderInitEventArgs.FieldDisplayList = _rowFieldDisplayNames;
// Fire the RowProviderInit event.
RowProviderInit(this, rowProviderInitEventArgs);
}
}
}