IListConsumer.PartialListReady Method

NOTE: This API is now obsolete.

Provides an event handler for the PartialListReady event of a Web Part that implements the IListProvider interface.

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

Syntax

'Declaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")> _
Sub PartialListReady ( _
    sender As Object, _
    partialListReadyEventArgs As PartialListReadyEventArgs _
)
'Usage
Dim instance As IListConsumer
Dim sender As Object
Dim partialListReadyEventArgs As PartialListReadyEventArgs

instance.PartialListReady(sender, partialListReadyEventArgs)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")]
void PartialListReady(
    Object sender,
    PartialListReadyEventArgs partialListReadyEventArgs
)

Parameters

• sender
  Type: System.Object

  A Web Part that implements the IListProvider interface.

• partialListReadyEventArgs
  Type: Microsoft.SharePoint.WebPartPages.Communication.PartialListReadyEventArgs

  A PartialListReadyEventArgs that provides the consumed list.

Remarks

The PartialListReady method is executed when the first page of data from the consumed list is received.

Examples

The following code example shows the implementation of the PartialListReady event. This code example is part of a larger example provided for the IListConsumer 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 Sub PartialListReady(sender As Object, partialListReadyEventArgs As PartialListReadyEventArgs) _
      Implements IListConsumer.PartialListReady
End Sub
 
' 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 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.
}

See Also

Reference

IListConsumer Interface

IListConsumer Members

Microsoft.SharePoint.WebPartPages.Communication Namespace