WebPart.RegisterInterface-Methode (String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean)
HINWEIS: Diese API ist veraltet.
Registriert eine Schnittstelle aus dem Microsoft.SharePoint.WebPartPages.Communication -Namespace für ein verbindbares Webpart mit der Option angeben wie seitenübergreifenden Verbindungen behandelt werden.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<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 _
)
'Usage
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
)
Parameter
interfaceName
Typ: System.StringDer Anzeigename der Schnittstelle.
interfaceTypeName
Typ: System.StringDer Typ der Schnittstelle wie in den Feldern der InterfaceTypes -Klasse aufgeführt.
maxConnections
Typ: System.Int32Den angegebenen Grenzwert für die Anzahl der Verbindungen mit dieser Schnittstelle. Entweder LimitOneConnection oder UnlimitedConnectionskann sein.
runAtOptions
Typ: Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAtEin ConnectionRunAtWert, der angibt, in dem die Schnittstelle ausgeführt werden kann.
interfaceObject
Typ: System.ObjectEin Verweis auf die Schnittstelle implementiert.
interfaceClientReference
Typ: System.StringDie string verwendet, um die Schnittstelle im Skript für clientseitige Verbindungen, beispielsweise RowProviderInterface_WPQ_. verweisen
menuLabel
Typ: System.StringDie Bezeichnung, die in der Benutzeroberfläche zum Erstellen einer Webparts-Verbindung mit dieser Schnittstelle verwendet werden.
description
Typ: System.StringEine kurze Beschreibung der Schnittstelle, die in der Benutzeroberfläche zum Erstellen einer Webparts-Verbindung mit dieser Schnittstelle verwendet werden.
allowCrossPageConnection
Typ: System.BooleanGibt an, ob diese Verbindungsschnittstelle in der Benutzeroberfläche von dokumenterstellungsumgebungen zum Herstellen einer Verbindung über zwei Webparts-Seiten verfügbar gemacht wird. Wenn der Wert auf truefestgelegt ist, wird diese Verbindungsschnittstelle in der Erstellungsumgebung für das Erstellen von seitenübergreifenden Verbindungen den Einschränkungen der die von der Webpartinfrastruktur definierten Verbindung Kompatibilitätsregeln verfügbar gemacht. Wenn der Wert auf falsefestgelegt ist, ist die Schnittstelle nicht zum Erstellen von seitenübergreifenden Verbindungen verfügbar.
Hinweise
Bei der Entwicklung eines verbindbaren Webparts, sollten Sie diese Methode für jede Schnittstelle in der EnsureInterfaces -Methode für das Webpart einmal aufrufen.
Hinweis
Diese Methode ist eine der beiden überladenen RegisterInterface -Methoden. Die andere Methode RegisterInterface umfasst Parameters allowCrossPageConnection nicht in seiner Funktionssignatur und schwer Codes diese Einstellung, um die Standardwerte.
Beispiele
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.