(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean) del método WebPart.RegisterInterface
NOTA: esta API está ahora obsoleta.
Registra una interfaz desde el espacio de nombres Microsoft.SharePoint.WebPartPages.Communication para un elemento Web conectable con la opción de especificar conexiones entre páginas cómo se administran.
Espacio de nombres: Microsoft.SharePoint.WebPartPages
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
<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
Tipo: System.StringEl nombre descriptivo de la interfaz.
interfaceTypeName
Tipo: System.StringEl tipo de la interfaz, como se muestra en los campos de la clase InterfaceTypes .
maxConnections
Tipo: System.Int32El límite especificado en el número de conexiones a esta interfaz. Puede ser LimitOneConnection o UnlimitedConnections.
runAtOptions
Tipo: Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAtUn ConnectionRunAtvalorque especifica dónde se puede ejecutar la interfaz.
interfaceObject
Tipo: System.ObjectUna referencia a la interfaz implementada.
interfaceClientReference
Tipo: System.Stringstring que se usa para hacer referencia a la interfaz de la secuencia de comandos de conexiones de cliente, por ejemplo RowProviderInterface_WPQ_.
menuLabel
Tipo: System.StringLa etiqueta que se usará en la interfaz de usuario para crear una conexión de elementos Web con esta interfaz.
description
Tipo: System.StringUna breve descripción de la interfaz que se usará en la interfaz de usuario para crear una conexión de elementos Web con esta interfaz.
allowCrossPageConnection
Tipo: System.BooleanEspecifica si esta interfaz de conexión se expone en la interfaz de usuario de creación de entornos para la creación de una conexión entre dos páginas de elementos Web. Si el valor se establece en true, esta interfaz de conexión se expone en el entorno de creación para crear conexiones entre páginas dentro de las limitaciones de las reglas de compatibilidad de conexión definidas por la infraestructura de elementos Web. Si el valor se establece en false, la interfaz no está disponible para la creación de conexiones entre páginas.
Comentarios
Al desarrollar un elemento Web conectable, debe llamar a este método una vez para cada interfaz en el método EnsureInterfaces para el elemento Web.
Nota
Este método es uno de los dos métodos sobrecargados RegisterInterface . El otro método, RegisterInterface no incluye el parámetro allowCrossPageConnection en su firma de la función y códigos de duros esta configuración a los valores predeterminados.
Ejemplos
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.