Метод WebPart.RegisterInterface (String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean)

Статья
05/13/2015

Примечание. Этот API устарел.

Регистрирует интерфейс из пространства имен Microsoft.SharePoint.WebPartPages.Communication для подключаемых веб-части с возможностью обработки указание как межстраничных подключениях.

Пространство имен: Microsoft.SharePoint.WebPartPages
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
<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 _
)
'Применение
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
)

Параметры

interfaceName
Тип: System.String

Понятное имя интерфейса.

interfaceTypeName
Тип: System.String

Тип интерфейса, перечисленные в разделе поля класса InterfaceTypes .

maxConnections
Тип: System.Int32

Указанный ограничение на количество подключений к этот интерфейс. Может быть LimitOneConnection или UnlimitedConnections.

runAtOptions
Тип: Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAt

ConnectionRunAtзначение, указывающее, где может выполняться через интерфейс.

interfaceObject
Тип: System.Object

Ссылка на реализацию интерфейса.

interfaceClientReference
Тип: System.String

string , используемый для ссылки интерфейса в сценарии для подключения со стороны клиента, например RowProviderInterface_WPQ_.

menuLabel
Тип: System.String

Метка, которая будет использоваться для создания подключения веб-части с помощью этого интерфейса в пользовательском интерфейсе.

description
Тип: System.String

Краткое описание интерфейса, который будет использоваться для создания подключения веб-части с помощью этого интерфейса в пользовательском интерфейсе.

allowCrossPageConnection
Тип: System.Boolean

Указывает, будет ли этот интерфейс подключения предоставляется в пользовательском интерфейсе сред для создания подключения между двумя страницами веб-части разработки. Если значение для trueэтот интерфейс подключения предоставляется в среду разработки для создания межстраничных подключениях в рамках ограничения правила совместимости подключения, определенные в инфраструктуре веб-части. Если значение для falseинтерфейса недоступен для разработки межстраничных подключениях.

Замечания

При разработке подключаемых веб-части, следует вызывать этот метод один раз для каждого интерфейса в методе EnsureInterfaces для веб-части.

Примечание

Этот метод является одним из двух методов перегруженные RegisterInterface . Другой метод, RegisterInterface не включает параметр allowCrossPageConnection в его подписи функции и жестко коды этот параметр, чтобы значения по умолчанию.