WebPartConnection Класс

Определение

Пространство имен:

System.Web.UI.WebControls.WebParts

Сборка:

System.Web.dll

Предоставляет объект, который позволяет двум элементам управления WebPart устанавливать подключение. Этот класс не наследуется.

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 элементы управления (поставщик и потребитель) объявляются в элементе <asp:webpartzone> веб-страницы внутри <zonetemplate> элемента .

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

Второй метод формирования соединения между элементами управления предоставляется элементом <asp:connectionszone> на странице. Если пользователь переключает страницу в режим отображения подключения во время выполнения и щелкает команду connect в одном из пользовательских элементов управления, <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> . Введите текст в элементе управления "Поставщик почтовых индексов ", и он будет отображаться в элементе управления "Потребитель". Затем отключите два элемента управления. С помощью элемента управления раскрывающимся списком Режим отображения измените страницу на подключение режима отображения. Щелкните меню глаголов (представленную стрелкой вниз в строке заголовка) для каждого элемента WebPart управления и обратите внимание, что для каждого элемента управления есть параметр Connect . Это команда connect, которая отображается в меню глаголов только в том случае, если страница находится в режиме подключения. Щелкните команду connect в одном из элементов управления, и появится пользовательский интерфейс подключения, предоставляемый элементом ConnectionsZone управления . Нажмите кнопку Отключить , чтобы завершить статическое подключение между элементами управления. Используйте элемент управления Режим отображения , чтобы вернуть страницу в режим просмотра. Попробуйте ввести новый текст в поставщике еще раз и обратите внимание, что, так как элементы управления отключены, текст не обновляется в элементе управления-получателе.

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

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

Комментарии

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

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

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

• Элементы управления, находящиеся в 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 ссылается на ProviderConnectionPoint объект , а ProviderConnectionPointID свойство ссылается на идентификатор точки подключения поставщика.

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

Конструкторы

WebPartConnection()

Инициализирует новый экземпляр класса WebPartConnection.

Свойства

Consumer	Получает объект WebPart, который функционирует в подключении как элементу правления получателя.
ConsumerConnectionPoint	Получает объект, который служит в качестве точки подключения для элементов управления, функционирующих в подключении в качестве получателя.
ConsumerConnectionPointID	Получает или задает значение свойства для подключения, которое ссылается на идентификатор объекта, служащего в качестве точки подключения получателя для этого подключения.
ConsumerID	Получает или задает значение свойства для подключения, которое ссылается на идентификатор элемента управления WebPart, функционирующего в качестве получателя для этого подключения.
ID	Получает или задает идентификатор объекта WebPartConnection.
IsActive	Получает значение, которое указывает, существует ли в настоящее время объект WebPartConnection и способен ли передавать данные между элементами управления поставщика и получателя.
IsShared	Получает значение, указывающее, является ли объект WebPartConnection видимым для всех пользователей или же только для текущего пользователя.
IsStatic	Получает значение, указывающее, объявлен ли объект WebPartConnection в разметке веб-страницы или же создан программным способом.
Provider	Получает элемент управления WebPart, который функционирует как поставщик в подключении веб-частей.
ProviderConnectionPoint	Получает объект, который служит как точка подключения для элемента управления WebPart, выполняющего функцию поставщика в подключении.
ProviderConnectionPointID	Получает или задает значение свойства для подключения, которое ссылается на идентификатор объекта, выполняющего роль точки подключения поставщика для этого подключения.
ProviderID	Получает или задает значение свойства для подключения, которое ссылается на идентификатор элемента управления WebPart, выполняющего роль поставщика для этого подключения.
Transformer	Получает объект WebPartTransformer, который используется для преобразования данных между двумя несовместимыми точками подключения в подключении веб-частей.
Transformers	Получает коллекцию WebPartTransformer объектов, используемых внутренне набором элементов управления веб-частей.

Методы

Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
ToString()	Переопределяет унаследованный метод ToString() и возвращает краткое имя типа для объекта подключения.

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

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