ConsumerConnectionPoint Класс

Определение

public ref class ConsumerConnectionPoint : System::Web::UI::WebControls::WebParts::ConnectionPoint

public class ConsumerConnectionPoint : System.Web.UI.WebControls.WebParts.ConnectionPoint

type ConsumerConnectionPoint = class
    inherit ConnectionPoint

Public Class ConsumerConnectionPoint
Inherits ConnectionPoint

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

Object

ConnectionPoint

ConsumerConnectionPoint

Примеры

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

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

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

• Исходный код для интерфейса и два 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 , который реализует интерфейс и выступает в качестве элемента управления поставщика. Другой 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 директивы для регистрации пользовательских элементов управления, образующих подключение, и пользовательский элемент управления, позволяющий пользователям изменять режимы отображения на странице. Само соединение создается декларативно внутри <staticconnections> элемента на странице. Это демонстрирует один из способов создания соединения — обратите внимание на ConsumerConnectionPointID атрибут в элементе <asp:webpartconnection> . Вы также можете создать подключение программным способом. код для этого находится в методе Button1_Click . В этом случае создается объект , ConsumerConnectionPoint а затем передается методу, который создает фактическое соединение. Независимо от того, создается ли соединение декларативным или программным способом, точки подключения всегда должны указываться как для поставщика, так и для потребителя. Метод Button2_Click обращается ConnectionPoint к объектам как для поставщика, так и для потребителя и записывает некоторые значения их свойств в метку на странице.

<%@ 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"];
      
    if(mgr.CanConnectWebParts(zip1, provPoint, weather1, connPoint))
      mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint);
  
  }  
  protected void Button2_Click(object sender, EventArgs e)
  {
    WebPartConnection conn = mgr.Connections[0];
    
    lblConn.Text = "<h2>Connection Point Details</h2>" + 
       "<h3>Provider Connection Point</h3>" + 
       "  Display name: " + conn.ProviderConnectionPoint.DisplayName + 
       "<br />" + 
       "  ID: " + conn.ProviderConnectionPoint.ID + 
       "<br />" + 
       "  Interface type: " + 
        conn.ProviderConnectionPoint.InterfaceType.ToString() + 
       "<br />" + 
       "  Control type: " + conn.ProviderConnectionPoint.ControlType.ToString() + 
       "<br />" + 
       "  Allows multiple connections: " + 
          conn.ProviderConnectionPoint.AllowsMultipleConnections.ToString() + 
       "<br />" + 
       "  Enabled: " + conn.ProviderConnectionPoint.GetEnabled(zip1).ToString() + 
       "<hr />" + 
       "<h3>Consumer Connection Point</h3>" + 
       "  Display name: " + conn.ConsumerConnectionPoint.DisplayName + 
       "<br />" + 
       "  ID: " + conn.ConsumerConnectionPoint.ID + 
       "<br />" + 
       "  Interface type: " + conn.ConsumerConnectionPoint.InterfaceType.ToString() + 
       "<br />" + 
       "  Control type: " + conn.ConsumerConnectionPoint.ControlType.ToString() + 
       "<br />" + 
       "  Allows multiple connections: " + 
          conn.ConsumerConnectionPoint.AllowsMultipleConnections.ToString() + 
       "<br />" + 
       "  Enabled: " + conn.ConsumerConnectionPoint.GetEnabled(zip1).ToString();
  }

  protected void Page_Load(object sender, EventArgs e)
  {
    lblConn.Text = String.Empty;
  }
</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" >
        <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="Dynamic Connection" 
        OnClick="Button1_Click" />      
      <br />
      <asp:Button ID="Button2" runat="server" 
        Text="Connection Point Details" 
        OnClick="Button2_Click" />
      <br />
      <asp:Label ID="lblConn" runat="server" />
    </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")

    If mgr.CanConnectWebParts(zip1, provPoint, weather1, connPoint) Then
      mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint)
    End If
    
  End Sub
  
  Protected Sub Button2_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    
    Dim conn As WebPartConnection = mgr.Connections(0)

    lblConn.Text = "<h2>Connection Point Details</h2>" & _
      "<h3>Provider Connection Point</h3>" & _
      "  Display name: " & conn.ProviderConnectionPoint.DisplayName & _
      "<br />" & _
      "  ID: " & conn.ProviderConnectionPoint.ID & _
      "<br />" & _
      "  Interface type: " & conn.ProviderConnectionPoint.InterfaceType.ToString() & _
      "<br />" & _
      "  Control type: " & conn.ProviderConnectionPoint.ControlType.ToString() & _
      "<br />" & _
      "  Allows multiple connections: " & _
        conn.ProviderConnectionPoint.AllowsMultipleConnections.ToString() & _
      "<br />" & _
      "  Enabled: " & conn.ProviderConnectionPoint.GetEnabled(zip1).ToString() & _
      "<hr />" & _
      "<h3>Consumer Connection Point</h3>" & _
      "  Display name: " & conn.ConsumerConnectionPoint.DisplayName & _
      "<br />" & _
      "  ID: " & conn.ConsumerConnectionPoint.ID & _
      "<br />" & _
      "  Interface type: " & conn.ConsumerConnectionPoint.InterfaceType.ToString() & _
      "<br />" & _
      "  Control type: " & conn.ConsumerConnectionPoint.ControlType.ToString() & _
      "<br />" & _
      "  Allows multiple connections: " & _
        conn.ConsumerConnectionPoint.AllowsMultipleConnections.ToString() & _
      "<br />" & _
      "  Enabled: " & conn.ConsumerConnectionPoint.GetEnabled(zip1).ToString()
          
  End Sub

  Protected Sub Page_Load(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    lblConn.Text = String.Empty
  End Sub
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="mgr" runat="server" >
        <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="Dynamic Connection" 
        OnClick="Button1_Click" />      
      <br />
      <asp:Button ID="Button2" runat="server" 
        Text="Connection Point Details" 
        OnClick="Button2_Click" />
      <br />
      <asp:Label ID="lblConn" runat="server" />
    </div>
    </form>
</body>
</html>

После загрузки страницы в браузере нажмите кнопку Сведения о точке подключения . Появятся сведения о точках подключения поставщика и потребителя, установленных в декларативном соединении. Затем используйте раскрывающийся список Режим отображения , чтобы переключить страницу в режим подключения. В меню глаголы элемента управления "ПоставщикWebPart почтовых индексов" (представленном стрелкой вниз в строке заголовка) щелкните команду connect. Появится пользовательский интерфейс подключения, автоматически созданный элементом <asp:connectionszone> управления, объявленным на странице. Это еще один способ создания соединения (с помощью пользовательского интерфейса) наряду с декларативными и программными методами, рассмотренными ранее. Нажмите кнопку Отключить , чтобы завершить существующее статическое подключение. Щелкните ссылку Create a Connection to a Consumer (Создать подключение к потребителю ). Теперь в пользовательском интерфейсе отображается раскрывающийся элемент управления со списком отображаемого имени точки подключения потребителя. Выберите точку подключения в раскрывающемся списке и нажмите кнопку Подключить , чтобы завершить подключение. Затем снова нажмите кнопку Отключить . Нажмите кнопку Динамическое подключение , чтобы создать подключение программным способом. Используйте элемент управления Режим отображения , чтобы вернуть страницу в режим просмотра. Нажмите кнопку Сведения о точке подключения еще раз, чтобы еще раз указать сведения об объекте точки подключения потребителя.

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

Комментарии

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

Чтобы создать ConsumerConnectionPoint объект, необходимо выполнить несколько действий.

1. Включите элемент управления-получатель для ссылки на экземпляр интерфейса. Серверный WebPart элемент управления или другой серверный элемент управления (можно использовать любой тип серверного элемента управления, который будет добавлен WebPartZoneBase в зону) должен иметь возможность использовать данные из определенного экземпляра интерфейса. Элемент управления не должен реализовывать интерфейс ; Только поставщик должен реализовать его. Потребитель может работать с точным типом интерфейса, обслуживаемым поставщиком, или, если это не так, WebPartTransformer объект может использоваться для преобразования данных из типа интерфейса поставщика в тип, понятный потребителю. Типичный способ включения потребителя — объявить частное поле, содержащее ссылку на нужный тип интерфейса.

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

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

   Примечание

   Во время синхронного запроса потребитель должен запрашивать данные непосредственно у поставщика во время или сразу после PreRender события. Если во время асинхронного запроса метод обратного вызова поставщика не вызывается во время отрисовки, разработчик может предположить, что потребителю не были отправлены никакие данные.

После того как элемент управления был оснащен для работы в качестве потребителя, элемент управления может участвовать в подключениях (при условии, что элемент управления поставщика также оснащен и доступен). Чтобы создать статическое декларативное соединение в разметке веб-страницы, разработчики могут использовать <asp:webpartconnection> элемент . ConnectionConsumer Если атрибут в исходном коде потребителя, идентифицирующий метод обратного вызова, указывает идентификатор точки подключения, то это значение должно быть присвоено атрибуту ConsumerConnectionPointID в элементе <asp:webpartconnection> на странице. Причина, по которой разработчик может указать идентификатор для точки подключения потребителя, заключается в наличии нескольких точек подключения, определенных в элементе управления потребителем. Если идентификатор не указан для точки подключения потребителя в элементе управления объектом-получателем, то атрибуту на странице также не нужно присваивать ConsumerConnectionPointID значение, так как соединение будет создано с использованием значения по умолчанию, полученного DefaultID из поля .

Чтобы создать соединение в коде, разработчики должны создать новый ConsumerConnectionPoint объект, вызвав GetConsumerConnectionPoints метод и передав ему идентификатор элемента управления-получателя вместе с идентификатором или индексом определенного ConsumerConnectionPoint объекта в элементе управления-получателе. Возвращаемый ConsumerConnectionPoint объект вместе со ссылкой на элемент управления-получатель, ссылку на элемент управления поставщика и соответствующий ProviderConnectionPoint объект передаются ConnectWebParts методу для создания нового WebPartConnection объекта.

Хотя разработчики могут использовать точки подключения потребителей как часть установки подключений декларативно или программно, пользователи также могут взаимодействовать с точками подключения потребителей для установления подключений через пользовательский интерфейс. Если разработчики объявляют ConnectionsZone элемент управления на веб-странице, он предоставляет пользователям пользовательский интерфейс времени выполнения для создания подключений. Если пользователи выбирают элемент управления поставщиком в качестве отправной точки для установления подключения, щелкнув его команду подключения (они также могут выбрать потребителя; в результате подключения нет никакой разницы), в пользовательском интерфейсе они увидят элемент управления раскрывающимся списком с отображаемыми именами доступной точки подключения потребителя (или точек, если их несколько), в которую поставщик может отправить данные. Чтобы установить подключение, пользователи должны выбрать точку подключения потребителя.

Объект ConsumerConnectionPoint напрямую связывается с определенным элементом управления-получателем и сохраняет сведения о соединении в свойствах, наследуемых от базового ConnectionPoint класса. Например, в наследуемом InterfaceType свойстве точка подключения потребителя сохраняет тип используемого интерфейса. Если поставщик и потребитель в соединении понимают тип интерфейса, элементы управления совместимы и могут формировать прямое соединение. Если поставщик и потребитель не могут работать с одинаковым типом интерфейса, они несовместимы и должны использовать WebPartTransformer объект для преобразования свойства точки InterfaceType подключения поставщика в тип, с которым может работать потребитель. Еще одним важным унаследованным свойством DisplayName является свойство , которое предоставляет понятное имя, отображаемое в пользовательском интерфейсе, чтобы пользователи выбрали точку подключения потребителя при создании подключений. Отображаемое имя является обязательным параметром ConnectionConsumer , когда разработчики добавляют атрибут в метод обратного вызова в элементе управления-получателе. Унаследованное ID свойство также полезно, как указано выше, так как оно предоставляет уникальный идентификатор для точки подключения потребителя в случае, если потребитель имеет несколько точек подключения. Потребитель может иметь несколько объектов, определенных ConsumerConnectionPoint в нем, и в этом случае, когда разработчики добавляют ConnectionConsumer атрибут в метод, они должны указать значение идентификатора, чтобы различать каждую точку подключения. Еще одним заметным наследуемым свойством AllowsMultipleConnections является свойство , которое указывает, может ли точка подключения потребителя одновременно подключаться к нескольким поставщикам. Это значение свойства по умолчанию для false точек подключения потребителя (в то время как по умолчанию true — для точек подключения поставщика).

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

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

Свойства

Методы

Применяется к

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

• WebPartConnection
• ProviderConnectionPoint
• элементы управления веб-частей ASP.NET
• Общие сведения о подключениях веб-частей