WebPart.RegisterInterface - Méthode (String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean)
Remarque : cette API est désormais obsolète.
Enregistre une interface à partir de l'espace de noms Microsoft.SharePoint.WebPartPages.Communication pour un composant WebPart connectable avec l'option de spécification connexions entre pages Comment sont gérées.
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.")> _
Protected Sub RegisterInterface ( _
interfaceName As String, _
interfaceTypeName As String, _
maxConnections As Integer, _
runAtOptions As ConnectionRunAt, _
interfaceObject As Object, _
interfaceClientReference As String, _
menuLabel As String, _
description As String, _
allowCrossPageConnection As Boolean _
)
'Utilisation
Dim interfaceName As String
Dim interfaceTypeName As String
Dim maxConnections As Integer
Dim runAtOptions As ConnectionRunAt
Dim interfaceObject As Object
Dim interfaceClientReference As String
Dim menuLabel As String
Dim description As String
Dim allowCrossPageConnection As Boolean
Me.RegisterInterface(interfaceName, _
interfaceTypeName, maxConnections, _
runAtOptions, interfaceObject, interfaceClientReference, _
menuLabel, description, allowCrossPageConnection)
[ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")]
protected void RegisterInterface(
string interfaceName,
string interfaceTypeName,
int maxConnections,
ConnectionRunAt runAtOptions,
Object interfaceObject,
string interfaceClientReference,
string menuLabel,
string description,
bool allowCrossPageConnection
)
Paramètres
interfaceName
Type : System.StringLe nom convivial de l'interface.
interfaceTypeName
Type : System.StringLe type de l'interface, comme indiqué dans les champs de la classe InterfaceTypes .
maxConnections
Type : System.Int32La limite spécifiée sur le nombre de connexions à cette interface. Peut être LimitOneConnection ou UnlimitedConnections.
runAtOptions
Type : Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAtUn ConnectionRunAtvaleurqui indique où l'interface peut être exécuté.
interfaceObject
Type : System.ObjectUne référence à l'interface implémentée.
interfaceClientReference
Type : System.StringLa string permet de faire référence à l'interface de script pour les connexions côté client, par exemple RowProviderInterface_WPQ_.
menuLabel
Type : System.StringL'étiquette qui sera utilisé dans l'interface utilisateur pour la création d'une connexion de composant WebPart avec cette interface.
description
Type : System.StringUne brève description de l'interface qui sera utilisé dans l'interface utilisateur pour la création d'une connexion de composant WebPart avec cette interface.
allowCrossPageConnection
Type : System.BooleanSpécifie si l'interface de cette connexion est exposée dans l'interface utilisateur de création des environnements pour la création d'une connexion entre les deux pages de composants WebPart. Si la valeur est définie sur true, cette interface de connexion est exposée dans l'environnement de création pour la création de connexions entre pages dans les limites des compatibilité des règles de connexion définis par l'infrastructure de composant WebPart. Si la valeur est définie sur false, l'interface n'est pas disponible pour la création de connexions entre pages.
Remarques
Lors du développement d'un composant WebPart connectable, vous devez appeler cette méthode une fois pour chaque interface dans la méthode EnsureInterfaces pour le composant WebPart.
Notes
Cette méthode est une des deux méthodes surchargées RegisterInterface . L'autre méthode, RegisterInterface n'inclut pas le paramètre allowCrossPageConnection dans sa signature de la fonction et les codes durs ce paramètre pour les valeurs par défaut.
Exemples
For a code example that calls the RegisterInterface method, see RegisterInterface. For an overview of the steps of creating a connectable Web Part, see Walkthrough: Creating a Connectable SharePoint Web Part.