WebPart.RegisterInterface method (String, String, Int32, ConnectionRunAt, Object, String, String, String)
NOTE: This API is now obsolete.
Registra uma interface do namespace Microsoft.SharePoint.WebPartPages.Communication para uma Web Part conectável.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
<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 _
)
'Uso
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
)
Parâmetros
interfaceName
Type: System.StringO nome amigável da interface.
interfaceType
Type: System.StringO tipo da interface conforme listado nos campos da classe InterfaceTypes .
maxConnections
Type: System.Int32O limite especificado no número de conexões para esta interface. Pode ser LimitOneConnection ou UnlimitedConnections.
runAtOptions
Type: Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAtUm ConnectionRunAt valorque especifica onde a interface pode ser executada.
interfaceObject
Type: System.ObjectUma referência para a interface implementada.
interfaceClientReference
Type: System.Stringstring usado para fazer referência a interface no script para conexões de cliente, por exemplo RowProviderInterface_WPQ_.
menuLabel
Type: System.StringO rótulo que será usado na interface do usuário para criar uma conexão entre Web Parts com esta interface.
description
Type: System.StringUma breve descrição da interface que será usado na interface do usuário para criar uma conexão entre Web Parts com esta interface.
Comentários
Ao desenvolver uma Web Part conectável, você deve chamar esse método uma vez para cada interface no método EnsureInterfaces para a Web Part.
Esse método é um dos dois métodos sobrecarregados RegisterInterface . O parâmetro allowCrossPageConnection não incluído na sua assinatura de função, que permite especificar se uma interface de conexão é exposta na interface do usuário de ambientes de criação de uma conexão entre duas páginas de Web Part de criação. Nesta versão do método, o parâmetro allowCrossPageConnection padrão true para todas as interfaces de conexão que são compatíveis com as regras de compatibilidade de conexão definidas pelo infra-estrutura de Web Part e false para todas as outras interfaces de conexão.
Para especificar o parâmetro allowCrossPageConnection , use o método [RegisterInterface(String,String,Int32,Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAt,object,String,String,String,Boolean)] .
Examples
O exemplo de código a seguir mostra um método substituído EnsureInterfaces que chama o método RegisterInterface . Este exemplo de código é parte de um exemplo maior fornecido para a interface ICellProvider .
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;
}
}