WebPart.RegisterInterface method (String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean)
NOTE: This API is now obsolete.
Registra uma interface do namespace Microsoft.SharePoint.WebPartPages.Communication para uma Web Part conectável com a opção de conexões de especificação como entre páginas são manipulados.
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, _
interfaceTypeName As String, _
maxConnections As Integer, _
runAtOptions As ConnectionRunAt, _
interfaceObject As Object, _
interfaceClientReference As String, _
menuLabel As String, _
description As String, _
allowCrossPageConnection As Boolean _
)
'Uso
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
)
Parâmetros
interfaceName
Type: System.StringO nome amigável da interface.
interfaceTypeName
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 ConnectionRunAtvalorque 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.
allowCrossPageConnection
Type: System.BooleanEspecifica se esta 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. Se o valor é definido como true, essa interface de conexão é exposta no ambiente de criação para criar conexões entre páginas dentro dos limites das regras de compatibilidade de conexão definidas pela infra-estrutura de Web Part. Se o valor é definido como false, a interface não está disponível para criação de conexões entre páginas.
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.
Dica
Esse método é um dos dois métodos sobrecarregados RegisterInterface . Outro método, RegisterInterface não inclui o parâmetro allowCrossPageConnection na sua assinatura de função e códigos de disco rígidos essa configuração para os valores padrão.
Examples
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.