WebPart.PartCommunicationConnect - Méthode

Article
05/12/2015

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

Utilisé pour notifier un composant WebPart qu'il a été connecté à un autre composant WebPart.

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

Syntaxe

'Déclaration
<ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")> _
Public Overridable Sub PartCommunicationConnect ( _
    interfaceName As String, _
    connectedPart As WebPart, _
    connectedInterfaceName As String, _
    runAt As ConnectionRunAt _
)
'Utilisation
Dim instance As WebPart
Dim interfaceName As String
Dim connectedPart As WebPart
Dim connectedInterfaceName As String
Dim runAt As ConnectionRunAt

instance.PartCommunicationConnect(interfaceName, _
    connectedPart, connectedInterfaceName, _
    runAt)

[ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")]
public virtual void PartCommunicationConnect(
    string interfaceName,
    WebPart connectedPart,
    string connectedInterfaceName,
    ConnectionRunAt runAt
)

Paramètres

interfaceName
Type : System.String

Spécifie le nom de l'interface sur ce composant WebPart qui est connectée.

connectedPart
Type : Microsoft.SharePoint.WebPartPages.WebPart

WebPart qui spécifie l'autre composant WebPart qui est connectée à.

connectedInterfaceName
Type : System.String

Spécifie le nom de l'interface qui est connectée à l'autre composant WebPart.

runAt
Type : Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAt

Une valeur deConnectionRunAtqui indique où l'interface sur ce composant WebPart doit être exécutée.

Remarques

Un composant WebPart qui implémente une interface de connexion doit substituer la méthode PartCommunicationConnect . Cette méthode est appelée par l'infrastructure de composant WebPart afin d'informer le composant WebPart qu'il est connecté au cours de l'événement System.Web.UI.Control.PreRender Microsoft ASP.NET. Transmission des informations pertinentes pour la connexion WebPart telles que l'interface est connecté via, le composant WebPart qu'il est en cours de connexion à et où le composant exécutera, côté client ou côté serveur.

Si le composant WebPart qui est connectée à se trouve sur une autre page, connectedPart est une référence Null (Rien dans Visual Basic).

Exemples

L'exemple de code suivant illustre une méthode substituée PartCommunicationConnect . Cet exemple de code fait partie d'un exemple plus complet fourni pour l'interface ICellProvider .

Étant donné que cet exemple utilise la classe Microsoft.SharePoint.Utilities.SPEncode , il nécessite une directive de using (Imports dans Visual Basic) pour l'espace de noms Microsoft.SharePoint.Utilities .

For an overview of the steps of creating a connectable Web Part, see Walkthrough: Creating a Connectable SharePoint Web Part.

Public Overrides Sub PartCommunicationConnect( _
    interfaceName As String, _
    connectedPart As WebPart, _
    connectedInterfaceName As String, _
    runAt As ConnectionRunAt)

   ' Keep track of whether the Web Part is connected.
   If interfaceName = "MyCellProviderInterface_WPQ_" Then
      _connected = True
      _connectedWebPartTitle = SPEncode.HtmlEncode(connectedPart.Title)
    End If
End Sub

// Step #7: Override the PartCommunicationConnect() method.
// The PartCommunicationConnect method is called by the Web Part infrastructure to notify the Web Part that it
// is connected during the ASP.NET PreRender event. Relevant information is passed to the part such as 
// the interface it is connected over, the Web Part it is being conected to, and where the part will be running, 
// either client-side or server-side. 
// <param name="interfaceName">Friendly name of the interface that is being connected</param>
// <param name="connectedPart">Reference to the other Web Part that is being connected to</param>
// <param name="connectedInterfaceName">Friendly name of the interface on the other Web Part</param>
// <param name="runAt">Where the interface should execute</param>
public override void PartCommunicationConnect(
    string interfaceName,
    WebPart connectedPart,
    string connectedInterfaceName,
    ConnectionRunAt runAt)
{
    // Keep track of whether the Web Part is connected.
    if (interfaceName == "MyCellProviderInterface_WPQ_")
    {
        _connected = true;
        _connectedWebPartTitle = SPEncode.HtmlEncode(connectedPart.Title);
    }
}

Voir aussi

Référence

WebPart classe

WebPart - Membres

Microsoft.SharePoint.WebPartPages - Espace de noms

Partager via