ListProviderInitEventArgs Class
NOTE: This API is now obsolete.
Provides the field names and optional field display names for the list provided by a Web Part that implements the IListProviderinterface when the ListProviderInit event occurs.
Inheritance Hierarchy
System.Object
System.EventArgs
Microsoft.SharePoint.WebPartPages.Communication.InitEventArgs
Microsoft.SharePoint.WebPartPages.Communication.ListProviderInitEventArgs
Namespace: Microsoft.SharePoint.WebPartPages.Communication
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")> _
Public NotInheritable Class ListProviderInitEventArgs _
Inherits InitEventArgs
'Usage
Dim instance As ListProviderInitEventArgs
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")]
public sealed class ListProviderInitEventArgs : InitEventArgs
Examples
The following code example shows an overridden WebPart.PartCommunicationInit method that creates an instance of the ListProviderInitEventArgs class to send when the ListProviderInit event occurs. This code example is part of a larger example provided for the IListProvider interface.
' Step #7: Override 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. 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.
' Ensure that all of the Web Part's controls are created.
EnsureChildControls()
' Check if connected.
If _connected Then
'Create the ListProviderInitEventArgs object for the ListProviderInit event.
Dim listProviderInitArgs As New ListProviderInitEventArgs()
' Set the list field names.
listProviderInitArgs.FieldList = _listFieldNames
listProviderInitArgs.FieldDisplayList = _listFieldDisplayNames
' Fire the ListProviderInit event.
ListProviderInit(Me, listProviderInitArgs)
End If
End Sub 'PartCommunicationInit
// Step #7: Override 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. 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)
{
//Create the ListProviderInitEventArgs object for the ListProviderInit event.
ListProviderInitEventArgs listProviderInitArgs = new ListProviderInitEventArgs();
// Set the list field names.
listProviderInitArgs.FieldList = _listFieldNames;
listProviderInitArgs.FieldDisplayList = _listFieldDisplayNames;
// Fire the ListProviderInit event.
ListProviderInit(this, listProviderInitArgs);
}
}
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.