IListConsumer.ListReady - Méthode

Article
05/12/2015

Remarque : cette API est désormais obsolète.

Fournit un gestionnaire d'événements pour l'événement ListReady d'un composant WebPart qui implémente l'interface IListProvider .

Espace de noms : Microsoft.SharePoint.WebPartPages.Communication
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")> _
Sub ListReady ( _
    sender As Object, _
    listReadyEventArgs As ListReadyEventArgs _
)
'Utilisation
Dim instance As IListConsumer
Dim sender As Object
Dim listReadyEventArgs As ListReadyEventArgs

instance.ListReady(sender, listReadyEventArgs)

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartTable instead")]
void ListReady(
    Object sender,
    ListReadyEventArgs listReadyEventArgs
)

Paramètres

sender
Type : System.Object

Un composant WebPart qui implémente l'interface IListProvider .

listReadyEventArgs
Type : Microsoft.SharePoint.WebPartPages.Communication.ListReadyEventArgs

ListReadyEventArgs qui fournit le contenu de la liste.

Remarques

La méthode ListReady est exécutée lorsque la liste en cours de consommation a été entièrement récupérée. Elle peut également être exécutée lorsque la liste consommé modifications (par exemple, lorsqu'une addition, la suppression, la mise à jour d'une ligne ou un changement de filtre se produit).

Exemples

L'exemple de code suivant illustre une implémentation de la méthode ListReady . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface IListConsumer .

' Step #7: Implement the ListReady event handler.
' The connected provider part(s) will call this method during its 
' PartCommunicationMain phase to pass their primary data to the 
' consumer Web Part.
' <param name="sender">Reference to the provider Web Part</param>
' <param name="listReadyEventArgs">The args passed by the provider Web 
' Part</param>
Public Sub ListReady(sender As Object, listReadyEventArgs As ListReadyEventArgs) _
     Implements IListConsumer.ListReady
   ' Ensure that all of the Web Part's controls are created.
   
   EnsureChildControls()
   
   ' Store the List that was passed by the provider Web Part. 
   If Not (listReadyEventArgs.List Is Nothing) Then
      _dataGrid.DataSource = listReadyEventArgs.List
      
      'Bind the data grid
       _dataGrid.DataBind()

   End If
End Sub 'ListReady

// Step #7: Implement the ListReady event handler.

// The connected provider part(s) will call this method during its 
// PartCommunicationMain phase to pass their primary data to the 
// consumer Web Part.

// <param name="sender">Reference to the provider Web Part</param>
// <param name="listReadyEventArgs">The args passed by the provider Web 
// Part</param>

public void ListReady(object sender, ListReadyEventArgs listReadyEventArgs)
{
    // Ensure that all of the Web Part's controls are created.
    EnsureChildControls();

    // Store the List that was passed by the provider Web Part. 
    if(listReadyEventArgs.List != null)
    {
        _dataGrid.DataSource = listReadyEventArgs.List;

        //Bind the data grid
        _dataGrid.DataBind();
    }
}

Voir aussi

Référence

IListConsumer interface

IListConsumer - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms

Partager via