ListReady Method

  • Article
  • 2 minutes to read

The ListReady method of the IListConsumer interface provides an event handler for the ListReady event of a Web Part that implements the IListProvider interface.

Parameters

sender   A Web Part that implements the IListProvider interface.

listReadyEventArgs   A ListReadyEventArgs that provides the list contents.

Remarks

The ListReady method is executed when the list being consumed has been entirely retrieved. It can also be executed when the list being consumed changes (for example, when an addition, deletion, update of a row, or filter change occurs).

Example

The following code example shows an implementation of the ListReady method. This code example is part of a larger example provided for the IListConsumer interface.

Requirements

Platforms: Microsoft Windows Server 2003

Security: Code Access Security. In addition, the WebPartPermissions.Connections permission is required to use this member.