Share via


PartialListReadyEventArgs class

NOTE: This API is now obsolete.

Provides the list of the first page of data to the PartialListReady event of the IListProvider interface.

Inheritance hierarchy

System.Object
  System.EventArgs
    Microsoft.SharePoint.WebPartPages.Communication.PartialListReadyEventArgs

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

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")> _
Public Class PartialListReadyEventArgs _
    Inherits EventArgs
'Usage
Dim instance As PartialListReadyEventArgs
[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")]
public class PartialListReadyEventArgs : EventArgs

Examples

The following code example shows an implementation of a PartialListReady event handler. This code example is part of a larger example provided for the IListProvider interface.

        // Step #8: Implement the PartialListReady event handler.
        // The connected provider part(s) will call this method during 
        // its PartCommunicationMain phase
        // to pass partial amounts of their primary data to the 
        // consumer Web Part. This is useful in 
        // scenarios involving large datasets that need to be streamed.
        
        // <param name="sender">Reference to the provider Web 
        // Part</param>
        // <param name="partialListReadyEventArgs">The args passed by 
        // the provider Web Part</param>
        public void PartialListReady(object sender, PartialListReadyEventArgs partialListReadyEventArgs)
        {
            // Because this class implements the IListConsumer 
            // interface, it must  implement the interface member 
            // PartialListReady. However, this example doesn't use any 
            // data that may be passed in here.
        }
        ' Step #8: Implement the PartialListReady event handler.
        ' The connected provider part(s) will call this method during 
        ' its PartCommunicationMain phase
        ' to pass partial amounts of their primary data to the 
        ' consumer Web Part. This is useful in 
        ' scenarios involving large datasets that need to be streamed.

        ' <param name="sender">Reference to the provider Web 
        ' Part</param>
        ' <param name="partialListReadyEventArgs">The args passed by 
        ' the provider Web Part</param>
        Public Sub PartialListReady(ByVal sender As Object, ByVal partialListReadyEventArgs As PartialListReadyEventArgs)
            ' Because this class implements the IListConsumer 
            ' interface, it must  implement the interface member 
            ' PartialListReady. However, this example doesn't use any 
            ' data that may be passed in here.
        End Sub

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

PartialListReadyEventArgs members

Microsoft.SharePoint.WebPartPages.Communication namespace