ICellProvider.CellReady - Événement

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

Se produit lorsqu'une cellule change par exemple, lorsqu'une cellule est sélectionnée ou mis à jour.

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

Syntaxe

'Déclaration
<ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")> _
Event CellReady As CellReadyEventHandler
'Utilisation
Dim instance As ICellProvider
Dim handler As CellReadyEventHandler

AddHandler instance.CellReady, handler

[ObsoleteAttribute("Use System.Web.UI.WebControls.WebParts.IWebPartField instead")]
event CellReadyEventHandler CellReady

Remarques

L'événement CellReady doit également être utilisé pour envoyer la valeur initiale de la cellule, le cas échéant. L'événement CellReady se produit chaque fois que le Gestionnaire d'événements PartCommunicationMain s'exécute. Pour les connexions côté client, l'événement CellReady peut se produire à tout moment après l'exécution de PartCommunicationMain .

Exemples

L'exemple de code suivant montre une méthode substituée PartCommunicationMain qui crée une structure de données CellReadyEventArgs pour contenir la valeur de la cellule fournie, définit la valeur de la cellule et déclenche ensuite l'événement CellReady . Cet exemple de code fait partie d'un exemple plus développé fourni pour l'interface ICellProvider .

      ' Step #10: Override the PartCommunicationMain() method.
      ' The PartCommunicationMain method is called by the Web Part 
      ' infrastructure on the client during 
      ' the ASP.Net PreRender event to allow the part to pass its 
      ' primary data to the other connected parts.
      ' It is important to always fire the CellReady event. Some parts
      ' may not behave properly if they are left waiting for this 
      ' information.
      Public Overrides Sub PartCommunicationMain()
            ' Check if connected.
            If _connected Then
                ' Create the CellReadyEventArgs data structure for the 
                ' CellProviderInit event.
                Dim cellReadyArgs As New CellReadyEventArgs()

                ' If the user clicked the button, then send the value.
                If _cellClicked Then
                    ' Set the cell to the value of the TextBox text
                    ' This is the value that will be sent to the 
                    ' Consumer
                    cellReadyArgs.Cell = _cellInput.Text
                Else
                    ' The user didn't actually click the button
                    ' so just send an empty string to the consumer.
                    cellReadyArgs.Cell = ""
                End If

                ' Fire the CellReady event.
                ' The Consumer will receive the cell value in its 
                ' CellReady event handler
                RaiseEvent CellReady(Me, cellReadyArgs)
            End If
        End Sub

// Step #10: Override the PartCommunicationMain() method.
// The PartCommunicationMain method is called by the Web Part 
// infrastructure on the client during 
// the ASP.Net PreRender event to allow the part to pass its primary 
// data to the other connected parts.
// It is important to always fire the CellReady event. Some parts
// may not behave properly if they are left waiting for this 
// information.
public override void PartCommunicationMain()
{
    // Check if connected.
    if(_connected)
    {
        // If there is a listener, fire the CellReady event.
        if (CellReady != null)
        {
            // Create the CellReadyEventArgs data structure for the 
            // CellProviderInit event.
            CellReadyEventArgs cellReadyArgs = new 
               CellReadyEventArgs();

            // If the user clicked the button, then send the value.
            if (_cellClicked)
            {
                // Set the cell to the value of the TextBox text.
                // This is the value that will be sent to the Consumer
                cellReadyArgs.Cell = _cellInput.Text;
            }
            else
            {
                // The user didn't actually click the button
                // so just send an empty string to the consumer.
                cellReadyArgs.Cell = "";
            }

            // Fire the CellReady event.
            // The Consumer will receive the cell value in its 
            // CellReady event handler
            CellReady(this, cellReadyArgs);
        }
    }
}

Voir aussi

Référence

ICellProvider interface

ICellProvider - Membres

Microsoft.SharePoint.WebPartPages.Communication - Espace de noms