WebPart.RegisterInterface-Methode (String, String, Int32, ConnectionRunAt, Object, String, String, String)
HINWEIS: Diese API ist veraltet.
Eine Schnittstelle aus dem Microsoft.SharePoint.WebPartPages.Communication -Namespace registriert für ein verbindbares Webpart.
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, _
interfaceType As String, _
maxConnections As Integer, _
runAtOptions As ConnectionRunAt, _
interfaceObject As Object, _
interfaceClientReference As String, _
menuLabel As String, _
description As String _
)
'Usage
Dim interfaceName As String
Dim interfaceType 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
Me.RegisterInterface(interfaceName, _
interfaceType, maxConnections, runAtOptions, _
interfaceObject, interfaceClientReference, _
menuLabel, description)
[ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")]
protected void RegisterInterface(
string interfaceName,
string interfaceType,
int maxConnections,
ConnectionRunAt runAtOptions,
Object interfaceObject,
string interfaceClientReference,
string menuLabel,
string description
)
Parameter
interfaceName
Typ: System.StringDer Anzeigename der Schnittstelle.
interfaceType
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 ConnectionRunAt Wert, 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.
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.
Diese Methode ist eine der beiden überladenen RegisterInterface -Methoden. Es umfasst nicht den Parameter allowCrossPageConnection in seiner Funktionssignatur dem können Sie angeben, ob eine Schnittstelle für die Verbindung auf der Benutzeroberfläche von dokumenterstellungsumgebungen zum Herstellen einer Verbindung über zwei Webparts-Seiten verfügbar gemacht wird. In dieser Version der Methode die Standardeinstellung allowCrossPageConnectiontrue für alle Verbindungsschnittstellen, die durch die von der Webpartinfrastruktur und false für alle anderen Verbindungsschnittstellen definierten Verbindung Kompatibilitätsregeln unterstützt werden.
Um den allowCrossPageConnection -Parameter angeben möchten, verwenden Sie stattdessen die [RegisterInterface(String,String,Int32,Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAt,object,String,String,String,Boolean)] -Methode.
Beispiele
Das folgende Codebeispiel zeigt eine überschriebene EnsureInterfaces -Methode, die die RegisterInterface -Methode aufruft. Dieses Codebeispiel ist Teil eines umfangreicheren Beispiels für die ICellProvider -Schnittstelle.
For an overview of the steps for creating a connectable Web Part, see Walkthrough: Creating a Connectable SharePoint Web Part.
' Step #4: Override the EnsureInterfaces() method and call the RegisterInterface method.
Public Overrides Sub EnsureInterfaces()
' If your Web Part is installed in the bin directory and the Code Access Security (CAS) setting doesn't
' allow Web Part Connections, an exception will be thrown. To allow your Web Part to behave
' well and continue working, a try/catch block should be used when attempting to register interfaces.
' Web Part Connections will only work if the level attribute of the <trust> tag in the
' web.config file is set to WSS_Minimal, WSS_Medium, or Full. By default a new SharePoint site
' is installed with the trust level set to WSS_Minimal.
Try
' Register the ICellProvider Interface
' <param name="interfaceName">Friendly name of the interface that is being implemented.
' It must be unique on the client so the _WPQ_ token is used.</param>
' <param name="interfaceType">Specifies which interface is being implemented.</param>
' <param name="maxConnections">Defines how many times this interface can be connected.</param>
' <param name="runAtOptions">Determines where the interface can run.</param>
' <param name="interfaceObject">Reference to the object that is implementing this interface.</param>
' <param name="interfaceClientReference">Name used to reference the interface on the client.
' It must be unique on the client so the _WPQ_ token is used.</param>
' <param name="menuLabel">Label for the interface which appears in the UI</param>
' <param name="description">Description of the interface which appears in the UI</param>
' <param name="allowCrossPageConnection">Specifies if the interface can connect to a Web Part
' on a different page. This is an optional parameter with a default of false. Note that only some
' server-side interfaces are allowed to connect across pages by the Web Part Infrastructure.
' The ICellProvider interface is not allowed to connect across pages.</param>
RegisterInterface("MyCellProviderInterface_WPQ_", InterfaceTypes.ICellProvider, WebPart.UnlimitedConnections, ConnectionRunAt.Server, Me, "CellProviderInterface_WPQ_", "Provide Cell To", "Provides a single value to a cell consumer Web Part.")
Catch se As SecurityException
_registrationErrorOccurred = True
End Try
End Sub
// Step #4: Override the EnsureInterfaces() method and call the RegisterInterface method.
public override void EnsureInterfaces()
{
// If your Web Part is installed in the bin directory and the Code Access Security (CAS) setting doesn't
// allow Web Part Connections, an exception will be thrown. To allow your Web Part to behave
// well and continue working, a try/catch block should be used when attempting to register interfaces.
// Web Part Connections will only work if the level attribute of the <trust> tag in the
// web.config file is set to WSS_Minimal, WSS_Medium, or Full. By default a new SharePoint site
// is installed with the trust level set to WSS_Minimal.
try
{
// Register the ICellProvider Interface
// <param name="interfaceName">Friendly name of the interface that is being implemented.
// It must be unique on the client so the _WPQ_ token is used.</param>
// <param name="interfaceType">Specifies which interface is being implemented.</param>
// <param name="maxConnections">Defines how many times this interface can be connected.</param>
// <param name="runAtOptions">Determines where the interface can run.</param>
// <param name="interfaceObject">Reference to the object that is implementing this interface.</param>
// <param name="interfaceClientReference">Name used to reference the interface on the client.
// It must be unique on the client so the _WPQ_ token is used.</param>
// <param name="menuLabel">Label for the interface which appears in the UI</param>
// <param name="description">Description of the interface which appears in the UI</param>
// <param name="allowCrossPageConnection">Specifies if the interface can connect to a Web Part
// on a different page. This is an optional parameter with a default of false. Note that only some
// server-side interfaces are allowed to connect across pages by the Web Part infrastructure.
// The ICellProvider interface is not allowed to connect across pages.</param>
RegisterInterface("MyCellProviderInterface_WPQ_", //InterfaceName
InterfaceTypes.ICellProvider, //InterfaceType
WebPart.UnlimitedConnections, //MaxConnections
ConnectionRunAt.Server, //RunAtOptions
this, //InterfaceObject
"CellProviderInterface_WPQ_", //InterfaceClientReference
"Provide Cell To", //MenuLabel
"Provides a single value to a cell consumer Web Part."); //Description
}
catch(SecurityException se)
{
_registrationErrorOccurred = true;
}
}