WebPartConnection Класс

Определение

public ref class WebPartConnection sealed

[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public sealed class WebPartConnection

[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type WebPartConnection = class

Public NotInheritable Class WebPartConnection

Наследование

Object

WebPartConnection

Атрибуты

TypeConverterAttribute

Примеры

В следующем примере кода показано, как создать простое соединение между двумя WebPart элементами управления. В примере демонстрируется три способа формирования соединения: декларативно, помещая теги для подключения в разметку веб-страницы; программно путем создания подключения в коде; и через пользовательский интерфейс, разместив ConnectionsZone элемент управления на странице, который позволяет пользователям устанавливать подключение.

Пример кода состоит из четырех частей:

• Пользовательский элемент управления, позволяющий изменить режим отображения веб-частей на странице.

• Исходный код интерфейса и два WebPart элемента управления, действующие в качестве поставщика и потребителя для подключения.

• Веб-страница для размещения всех элементов управления и запуска примера кода.

• Описание запуска примера страницы.

Первая часть этого примера кода — это пользовательский элемент управления, позволяющий пользователям изменять режимы отображения на веб-странице. Сохраните следующий исходный код в ASCX-файл, указав ему имя файла, назначенное Src атрибуту директивы для этого пользовательского Register элемента управления, который находится в верхней части размещенной веб-страницы. Дополнительные сведения о режимах отображения и описании исходного кода в этом элементе управления см. в пошаговом руководстве. Изменение режимов отображения на странице веб-частей.

<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }
    
  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
  ' Use a field to reference the current WebPartManager.
  Dim _manager As WebPartManager

  Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler Page.InitComplete, AddressOf InitComplete
  End Sub

  Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
      
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
      
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In _manager.SupportedDisplayModes
      Dim modeName As String = mode.Name
      ' Make sure a mode is enabled before adding it.
      If mode.IsEnabled(_manager) Then
        Dim item As New ListItem(modeName, modeName)
        DisplayModeDropdown.Items.Add(item)
      End If
    Next mode
      
    ' If shared scope is allowed for this user, display the scope-switching
    ' UI and select the appropriate radio button for the current user scope.
    If _manager.Personalization.CanEnterSharedScope Then
      Panel2.Visible = True
      If _manager.Personalization.Scope = PersonalizationScope.User Then
        RadioButton1.Checked = True
      Else
        RadioButton2.Checked = True
      End If
    End If
   
  End Sub

  ' Change the page to the selected display mode.
  Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue   
    Dim mode As WebPartDisplayMode = _
      _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
      _manager.DisplayMode = mode
    End If

  End Sub
   
  ' Set the selected item equal to the current display mode.
  Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
    Dim items As ListItemCollection = DisplayModeDropdown.Items
    Dim selectedIndex As Integer = _
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
    DisplayModeDropdown.SelectedIndex = selectedIndex

  End Sub

  ' Reset all of a user's personalization data for the page.
  Protected Sub LinkButton1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    _manager.Personalization.ResetPersonalizationState()
    
  End Sub

  ' If not in User personalization scope, toggle into it.
  Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.Scope = PersonalizationScope.Shared Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub
   
  ' If not in Shared scope, and if user is allowed, toggle the scope.
  Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.CanEnterSharedScope AndAlso _
      _manager.Personalization.Scope = PersonalizationScope.User Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub

</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

Второй частью примера кода является исходный код для интерфейса и элементов управления. Исходный файл содержит простой интерфейс с именем IZipCode. Существует также WebPart класс с именем ZipCodeWebPart , который реализует интерфейс и выступает в качестве элемента управления поставщиком. Его ProvideIZipCode метод — это метод обратного вызова, реализующий единственный член интерфейса. Метод просто возвращает экземпляр интерфейса. Обратите внимание, что метод помечается атрибутом ConnectionProvider в его метаданных. Это механизм идентификации метода в качестве метода обратного вызова для точки подключения поставщика. Другой WebPart класс называется WeatherWebPart, и он выступает в качестве потребителя для подключения. Этот класс имеет метод с именем GetZipCode , который получает экземпляр IZipCode интерфейса из элемента управления поставщиком. Обратите внимание, что этот метод помечается как метод точки подключения потребителя атрибутом ConnectionConsumer в его метаданных.

Для запуска примера кода необходимо скомпилировать этот исходный код. Вы можете скомпилировать его явным образом и поместить полученную сборку в папку bin веб-сайта или глобальный кэш сборок. Кроме того, исходный код можно поместить в папку App_Code сайта, где он будет динамически скомпилирован во время выполнения. В этом примере кода используется динамическая компиляция. Пошаговое руководство по компиляции см. в руководстве по разработке и использованию пользовательского веб-сервера.

namespace Samples.AspNet.CS.Controls
{
  using System;
  using System.Web;
  using System.Web.Security;
  using System.Security.Permissions;
  using System.Web.UI;
  using System.Web.UI.WebControls;
  using System.Web.UI.WebControls.WebParts;

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public interface IZipCode
  {
    string ZipCode { get; set;}
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class ZipCodeWebPart : WebPart, IZipCode
  {
    string zipCodeText = String.Empty;
    TextBox input;
    Button send;

    public ZipCodeWebPart()
    {
    }

    // Make the implemented property personalizable to save 
    // the Zip Code between browser sessions.
    [Personalizable()]
    public virtual string ZipCode
    {
      get { return zipCodeText; }
      set { zipCodeText = value; }
    }

    // This is the callback method that returns the provider.
    [ConnectionProvider("Zip Code Provider", "ZipCodeProvider")]
    public IZipCode ProvideIZipCode()
    {
      return this;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      input = new TextBox();
      this.Controls.Add(input);
      send = new Button();
      send.Text = "Enter 5-digit Zip Code";
      send.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(send);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      if (!string.IsNullOrEmpty(input.Text))
      {
        zipCodeText = Page.Server.HtmlEncode(input.Text);
        input.Text = String.Empty;
      }
    }
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class WeatherWebPart : WebPart
  {
    private IZipCode _provider;
    string _zipSearch;
    Label DisplayContent;

    // This method is identified by the ConnectionConsumer 
    // attribute, and is the mechanism for connecting with 
    // the provider. 
    [ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")]
    public void GetIZipCode(IZipCode Provider)
    {
      _provider = Provider;
    }
    
    protected override void OnPreRender(EventArgs e)
    {
      EnsureChildControls();

      if (this._provider != null)
      {
        _zipSearch = _provider.ZipCode.Trim();
        DisplayContent.Text = "My Zip Code is:  " + _zipSearch;
      }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      this.Controls.Add(DisplayContent);
    }
  }
}

Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Interface IZipCode

    Property ZipCode() As String

  End Interface

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class ZipCodeWebPart
    Inherits WebPart
    Implements IZipCode
    Private zipCodeText As String = String.Empty
    Private input As TextBox
    Private send As Button

    Public Sub New()
    End Sub

    ' Make the implemented property personalizable to save 
    ' the Zip Code between browser sessions.
    <Personalizable()> _
    Public Property ZipCode() As String _
      Implements IZipCode.ZipCode

      Get
        Return zipCodeText
      End Get
      Set(ByVal value As String)
        zipCodeText = value
      End Set
    End Property

    ' This is the callback method that returns the provider.
    <ConnectionProvider("Zip Code Provider", "ZipCodeProvider")> _
    Public Function ProvideIZipCode() As IZipCode
      Return Me
    End Function


    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      input = New TextBox()
      Me.Controls.Add(input)
      send = New Button()
      send.Text = "Enter 5-digit Zip Code"
      AddHandler send.Click, AddressOf Me.submit_Click
      Me.Controls.Add(send)

    End Sub


    Private Sub submit_Click(ByVal sender As Object, _
      ByVal e As EventArgs)

      If input.Text <> String.Empty Then
        zipCodeText = Page.Server.HtmlEncode(input.Text)
        input.Text = String.Empty
      End If

    End Sub

  End Class

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class WeatherWebPart
    Inherits WebPart
    Private _provider As IZipCode
    Private _zipSearch As String
    Private DisplayContent As Label

    ' This method is identified by the ConnectionConsumer 
    ' attribute, and is the mechanism for connecting with 
    ' the provider. 
    <ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")> _
    Public Sub GetIZipCode(ByVal Provider As IZipCode)
      _provider = Provider
    End Sub


    Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
      EnsureChildControls()

      If Not (Me._provider Is Nothing) Then
        _zipSearch = _provider.ZipCode.Trim()
                DisplayContent.Text = "My Zip Code is:  " + _zipSearch
      End If

    End Sub

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      Me.Controls.Add(DisplayContent)

    End Sub

  End Class

End Namespace

Третья часть примера кода — веб-страница. Вверху находятся Register директивы для пользовательского элемента управления и пользовательских WebPart элементов управления. Так как в примере предполагается динамическая компиляция элементов управления, исходный код для элементов управления должен находиться в подпапке App_Code; Register Тег на странице ссылается только на префикс произвольного тега и пространство имен элементов управления. Пользовательские WebPart элементы управления (поставщик и потребитель) объявляются внутри элемента <zonetemplate> веб-страницы<asp:webpartzone>.

Страница предоставляет три способа формирования соединения между пользовательскими элементами управления. Первый метод является декларативным. В разметке страницы <StaticConnections> объявляется элемент и внутри этого <asp:WebPartConnections> элемента с различными сведениями о потребителе и поставщике соединения, указанного в качестве атрибутов. Это один из способов создания подключения, объявив его непосредственно на веб-странице, в частности в элементе <asp:WebPartManager> . Из-за этого статического подключения соединение между двумя пользовательскими элементами управления создается немедленно при первом загрузке страницы.

Второй метод формирования соединения между элементами управления предоставляется <asp:connectionszone> элементом на странице. Если пользователь переключает страницу в режим отображения подключения во время выполнения и щелкает команду подключения на одном из пользовательских элементов управления, <asp:connectionszone> элемент автоматически отображает пользовательский интерфейс для создания подключения.

На странице также показан третий способ создания подключения, который выполняется программным способом. В методе Button1_Click код создает ProviderConnectionPoint объект для элемента управления поставщиком и извлекает сведения о точке подключения путем вызова GetProviderConnectionPoints метода. Она выполняет аналогичную задачу для элемента управления потребителем, вызывая GetConsumerConnectionPoints метод. Наконец, он создает новый WebPartConnection объект, вызывая ConnectWebParts метод в элементе WebPartManager управления.

<%@ Page Language="C#" %>
<%@ Register TagPrefix="uc1" 
    TagName="DisplayModeMenuCS"
    Src="~/displaymodemenucs.ascx" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="Samples.AspNet.CS.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  protected void Button1_Click(object sender, EventArgs e)
  {
    ProviderConnectionPoint provPoint = 
      mgr.GetProviderConnectionPoints(zip1)["ZipCodeProvider"];
    ConsumerConnectionPoint connPoint = 
      mgr.GetConsumerConnectionPoints(weather1)["ZipCodeConsumer"];
    WebPartConnection conn1 = mgr.ConnectWebParts(zip1, provPoint,
      weather1, connPoint);
  }

  protected void mgr_DisplayModeChanged(object sender, 
    WebPartDisplayModeEventArgs e)
  {
    if (mgr.DisplayMode == WebPartManager.ConnectDisplayMode)
      Button1.Visible = true;
    else
      Button1.Visible = false;
  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server" 
    OnDisplayModeChanged="mgr_DisplayModeChanged">
        <StaticConnections>
          <asp:WebPartConnection ID="conn1"
            ConsumerConnectionPointID="ZipCodeConsumer"
            ConsumerID="weather1"
            ProviderConnectionPointID="ZipCodeProvider"
            ProviderID="zip1" />
        </StaticConnections>
      </asp:WebPartManager>
      <uc1:DisplayModeMenuCS ID="menu1" runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" runat="server"
            Title="Zip Code Provider" />
          <aspSample:WeatherWebPart ID="weather1" runat="server" 
            Title="Zip Code Consumer" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
      </asp:ConnectionsZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Connect WebPart Controls" 
        OnClick="Button1_Click" 
    Visible="false" />
    </div>
    </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ Register TagPrefix="uc1" 
    TagName="DisplayModeMenuVB"
    Src="~/displaymodemenuvb.ascx" %>
<%@ Register TagPrefix="aspSample" 
    Namespace="Samples.AspNet.VB.Controls" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    
    Dim provPoint As ProviderConnectionPoint = _
      mgr.GetProviderConnectionPoints(zip1)("ZipCodeProvider")
    Dim connPoint As ConsumerConnectionPoint = _
      mgr.GetConsumerConnectionPoints(weather1)("ZipCodeConsumer")
    mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint)

  End Sub

  Protected Sub mgr_DisplayModeChanged (ByVal sender as Object, _
    ByVal e as WebPartDisplayModeEventArgs)

    If mgr.DisplayMode Is WebPartManager.ConnectDisplayMode Then
    Button1.Visible = True
    Else
    Button1.Visible = False
    End If

  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server" 
    OnDisplayModeChanged="mgr_DisplayModeChanged">
        <StaticConnections>
          <asp:WebPartConnection ID="conn1"
            ConsumerConnectionPointID="ZipCodeConsumer"
            ConsumerID="weather1"
            ProviderConnectionPointID="ZipCodeProvider"
            ProviderID="zip1" />
        </StaticConnections>
      </asp:WebPartManager>
      <uc1:DisplayModeMenuVB ID="menu1" runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" runat="server"
            Title="Zip Code Provider" />
          <aspSample:WeatherWebPart ID="weather1" runat="server" 
            Title="Zip Code Consumer" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
      </asp:ConnectionsZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Connect WebPart Controls" 
        OnClick="Button1_Click" 
    Visible="false" />
    </div>
    </form>
</body>
</html>

После загрузки веб-страницы в браузере первое подключение уже существует, так как оно объявляется в элементе <StaticConnections> . Введите текст в элементе управления поставщика ZIP-кода , и он будет отображаться в элементе управления потребителем. Затем отключите два элемента управления. В раскрывающемся списке режима отображения измените страницу для подключения к режиму отображения. Щелкните меню команд (представлено стрелкой вниз в строке заголовка) для каждого элемента WebPart управления и обратите внимание, что у каждого элемента управления есть параметр Connect . Это команда подключения, которая отображается в меню команд, только если страница находится в режиме подключения. Щелкните команду подключения на одном из элементов управления, а пользовательский интерфейс подключения, предоставленный элементом ConnectionsZone управления. Нажмите кнопку "Отключить ", чтобы завершить статическое соединение между элементами управления. Используйте элемент управления "Режим отображения ", чтобы вернуть страницу для просмотра. Повторите попытку ввести новый текст в поставщике и обратите внимание, что, поскольку элементы управления отключены, текст не может обновляться в элементе управления потребителем.

Затем используйте тот же метод, что и выше, чтобы снова переключить страницу в режим отображения подключения. Щелкните команду подключения для одного из элементов управления. Щелкните ссылку "Создать подключение " и используйте пользовательский интерфейс, предоставленный ConnectionsZone элементом управления, чтобы создать соединение между элементами управления. Это второй метод для создания подключения. Обратите внимание, что как только соединение будет сформировано, последняя строка, введенная в элементе управления поставщиком (которая не появилась, так как элементы управления были отключены) внезапно появится в потребителе, так как соединение было повторно создано. Нажмите кнопку "Отключить ", чтобы завершить только что созданное подключение. Верните страницу для просмотра в режиме просмотра. Введите новый текст в поставщике, чтобы продемонстрировать, что текст не обновлен, и что элементы управления снова отключены.

Верните страницу для подключения к режиму отображения. Вместо нажатия команды подключения нажмите кнопку "Подключить элементы управления веб-части ", которая иллюстрирует третий метод формирования соединения. Этот подход программно подключает элементы управления на одном простом шаге без необходимости использовать элемент ConnectionsZone управления. Обратите внимание, что по мере создания подключения последняя строка, введенная в поставщике, внезапно появится в элементе управления потребителем.

Комментарии

В наборе элементов управления веб-частей соединение — это связь между двумя WebPart (или другими серверами или пользователем), которые позволяют им совместно использовать данные. Эта возможность совместного использования данных позволяет использовать подключенные элементы управления способами, превышающими функциональные возможности, предоставляемые изолированными элементами управления. Например, если один элемент управления предоставляет данные почтового кода, а другой элемент управления может считывать эти данные и предоставлять локальную информацию о погоде на основе почтового индекса, то возможность подключения двух элементов управления обеспечивает большее значение для пользователей. Чтобы расширить этот пример, можно создать другие элементы управления, которые также отображают информацию на основе почтового индекса, например элемента управления со ссылками на локальные новости, и все эти элементы управления, которые могут работать с данными почтового кода, могут совместно использовать данные с одним элементом управления, предоставляющим почтовый индекс. Конечные пользователи приложений веб-частей могут создавать подключения между всеми такими совместимыми элементами управления непосредственно из веб-браузера, используя стандартный пользовательский интерфейс подключений, предоставляемый ConnectionsZone элементом управления, или с помощью пользовательского пользовательского интерфейса, предоставленного разработчиком.

Этот WebPartConnection обзор класса представляет собой общую инструкцию основных сведений о создании подключения. Дополнительные сведения о конкретных компонентах и требованиях, связанных с созданием подключений, см. в обзоре подключений веб-частей или в примерах ссылочных классов и кода, упомянутых в следующем обсуждении. Существует несколько основных аспектов подключения веб-частей:

• Два WebPart элемента управления. Каждое подключение веб-частей состоит из двух элементов управления. Элемент управления может участвовать в нескольких соединениях одновременно, но каждое соединение состоит из двух элементов управления. Элементы управления могут быть производными непосредственно от WebPart базового класса или могут быть другими элементами управления сервера, включая элементы управления ASP.NET, пользовательские серверные элементы управления и пользовательские элементы управления. Элементы управления, не производные от WebPart класса, если они помещаются в WebPartZoneBase зону, автоматически упаковываются в GenericWebPart объект во время выполнения, что позволяет им наследовать от класса и функции в WebPart качестве элементов управления во время WebPart выполнения.

• Элементы управления, находящиеся в WebPartZoneBase зонах. Оба WebPart элемента управления и любой другой тип управления сервером WebPartZoneBase должны находиться в зоне, чтобы иметь возможность участвовать в подключениях веб-частей (и большинство других функций веб-частей).

• Потребители и поставщики. В каждом подключении веб-частей есть два элемента управления: поставщик данных и потребитель данных. Поставщик предоставляет данные потребителю через указанный метод обратного вызова, который возвращает данные в виде интерфейса. (Пример создания и указания метода обратного вызова см. в разделе "Пример" этого раздела.) Этот метод обратного вызова называется точкой подключения поставщика. Сведения об этой точке подключения (понятное имя, идентификатор и тип возвращаемого интерфейса) содержатся в ProviderConnectionPoint объекте, связанном с элементом управления поставщиком. Потребитель получает данные с помощью указанного метода, который может принимать экземпляр интерфейса. Этот метод называется точкой подключения потребителя, а сведения о точке подключения (имя, идентификатор и тип интерфейса) содержатся в ConsumerConnectionPoint объекте, связанном с элементом управления потребителем.

• Совместимые элементы управления или допустимый преобразователь. Для работы подключения потребитель и поставщик должны быть совместимыми (то есть их указанные методы точки подключения могут работать с тем же типом интерфейса), или должен быть WebPartTransformer объект, способный переводить тип, предлагаемый поставщиком, в тип, понятный потребителю.

• Объект WebPartConnection. Для существования соединения должен быть экземпляр WebPartConnection класса, содержащего ссылки на элементы управления поставщиком и потребителем, а также сведения о точках подключения. Если поставщик и потребитель несовместимы и вместо этого используют WebPartTransformer объект для подключения, соединение ссылается на преобразователь.

• Средство установления соединения. После того как совместимые элементы управления потребителей и поставщиков были правильно разработаны с помощью методов точки подключения и размещены в зоне, а WebPartConnection объект доступен, последний базовый шаг — инициировать подключение. Одним из способов этого может быть создание подключения через пользовательский интерфейс. Если вы размещаете <asp:connectionszone> элемент на странице и другие необходимые компоненты для подключения, во время выполнения пользователь может переключить страницу в режим отображения подключения, щелкните команду подключения в меню команд поставщика или потребителя, а пользовательский интерфейс подключения (на ConnectionsZone основе элемента управления) появится. С помощью этого пользовательского интерфейса пользователь может инициировать подключение. Еще один способ инициировать подключение — это сделать это программным способом. В любом случае, будь то через пользовательский интерфейс или программно, базовый метод, инициирующий подключение, совпадает. Приложение вызывает ConnectWebParts метод (или ConnectWebParts метод, если используется преобразователь) в WebPartManager элементе управления, передав его поставщику, потребителю и соответствующим объектам точки подключения, а метод возвращает WebPartConnection объект.

Класс WebPartConnection определяет объект, инкапсулирующий основные сведения о соединении между двумя WebPart элементами управления. Класс состоит почти полностью из свойств, связанных с подробными сведениями о конкретном соединении. Некоторые свойства касаются элемента управления потребителем в соединении. Свойство Consumer ссылается на сам элемент управления потребителем, а ConsumerID свойство ссылается на идентификатор потребителя. Объект ConsumerConnectionPoint , содержащий сведения о точке подключения потребителя, ссылается на свойство потребителя ConsumerConnectionPoint . Свойство ConsumerConnectionPointID ссылается на идентификатор ConsumerConnectionPoint объекта. Все эти свойства подключения, связанные с потребителем, должны иметь значение, назначенное им для создания подключения.

Класс WebPartConnection также имеет несколько свойств, связанных с элементом управления поставщиком в соединении, и они соответствуют свойствам для потребителя. Свойство Provider ссылается на сам элемент управления поставщика, а ProviderID свойство ссылается на его идентификатор. Свойство ProviderConnectionPoint ссылается на объект, а ProviderConnectionPointID свойство ссылается на ProviderConnectionPoint идентификатор точки подключения поставщика.

Некоторые свойства касаются состояния соединения. Свойство IsActive указывает, активен ли соединение (в настоящее время обмен данными) или неактивно (по-прежнему подключено, но не активно предоставляет доступ к данным). Свойство IsShared указывает, является ли подключение общим (доступным для всех пользователей страницы) или подключением для конкретного пользователя, а IsStatic свойство указывает, является ли элемент управления статическим (объявленным в разметке страницы и таким образом постоянным) или динамическим (созданным программным способом, то есть его можно удалить).

См. также раздел

• ConnectionPoint
• ProviderConnectionPoint
• ConsumerConnectionPoint
• WebPartManager
• ConnectionsZone
• WebPartTransformer
• ConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)
• Общие сведения о подключениях веб-частей
• элементы управления веб-частей ASP.NET