ConsumerConnectionPoint Klasa

Definicja

Przestrzeń nazw:

System.Web.UI.WebControls.WebParts

Zestaw:

System.Web.dll

Definiuje obiekt punktu połączenia, który umożliwia kontrolę serwera działającą jako odbiorca w celu utworzenia połączenia z dostawcą.

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

Dziedziczenie

Object

ConnectionPoint

ConsumerConnectionPoint

Przykłady

Poniższy przykład kodu przedstawia proste sposoby tworzenia połączenia deklaratywnie, programowo lub za pośrednictwem interfejsu użytkownika, w każdym przypadku korzystania z punktu połączenia konsumenta.

W przykładzie przedstawiono cztery części:

• Kontrolka użytkownika, która umożliwia zmianę trybu wyświetlania składników Web Part na stronie.

• Kod źródłowy interfejsu i dwie WebPart kontrolki działające jako dostawca i odbiorca połączenia.

• Strona sieci Web do hostowania wszystkich kontrolek i uruchomienia przykładu kodu.

• Wyjaśnienie sposobu uruchamiania przykładowej strony.

Pierwszą częścią tego przykładu kodu jest kontrolka użytkownika, która umożliwia użytkownikom zmienianie trybów wyświetlania na stronie sieci Web. Zapisz następujący kod źródłowy w pliku ascx, podając mu nazwę pliku przypisaną do Src atrybutu Register dyrektywy dla tej kontrolki użytkownika, która znajduje się w górnej części strony internetowej hostingu. Aby uzyskać szczegółowe informacje o trybach wyświetlania i opisie kodu źródłowego w tej kontrolce, zobacz Przewodnik: zmienianie trybów wyświetlania na stronie składników Web Part.

<%@ 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>

Drugą częścią przykładu kodu jest kod źródłowy interfejsu i kontrolek. Plik źródłowy zawiera prosty interfejs o nazwie IZipCode. Istnieje również WebPart klasa o nazwie ZipCodeWebPart , która implementuje interfejs i działa jako kontrolka dostawcy. Druga WebPart klasa ma nazwę WeatherWebParti działa jako odbiorca połączenia. Ta klasa ma metodę o nazwie GetZipCode , która pobiera wystąpienie interfejsu IZipCode z kontrolki dostawcy. Należy pamiętać, że ta metoda jest oznaczona jako metoda punktu połączenia odbiorcy z atrybutem ConnectionConsumer w metadanych. Jest to mechanizm identyfikowania metody punktu połączenia w kontrolce konsumenta.

Aby przykład kodu został uruchomiony, należy skompilować ten kod źródłowy. Można je jawnie skompilować i umieścić wynikowy zestaw w folderze Bin witryny sieci Web lub globalnej pamięci podręcznej zestawów. Możesz też umieścić kod źródłowy w folderze App_Code witryny, w którym będzie dynamicznie kompilowany w czasie wykonywania. W tym przykładzie kodu jest używana kompilacja dynamiczna. Aby zapoznać się z przewodnikiem, który pokazuje, jak skompilować, zobacz Przewodnik: opracowywanie i używanie niestandardowej kontrolki serwera sieci Web.

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

Trzecią częścią przykładu kodu jest strona sieci Web. W górnej części znajdują Register się dyrektywy służące do rejestrowania kontrolek niestandardowych, które tworzą połączenie, oraz kontrolki użytkownika, która umożliwia użytkownikom zmienianie trybów wyświetlania na stronie. Samo połączenie jest tworzone deklaratywnie w obrębie <staticconnections> elementu na stronie. Pokazuje to jeden ze sposobów tworzenia połączenia — zanotuj ConsumerConnectionPointID atrybut w elemecie <asp:webpartconnection> . Możesz również programowo utworzyć połączenie; kod umożliwiający wykonanie tej czynności w metodzie Button1_Click . W tym przypadku tworzony jest obiekt, ConsumerConnectionPoint a następnie przekazywany do metody, która tworzy rzeczywiste połączenie. Niezależnie od tego, czy połączenie jest tworzone deklaratywne, czy programowo, punkty połączenia muszą być zawsze określone zarówno dla dostawcy, jak i odbiorcy. Metoda Button2_Click uzyskuje ConnectionPoint dostęp do obiektów zarówno dostawcy, jak i konsumenta, a następnie zapisuje niektóre z ich wartości właściwości do etykiety na stronie.

<%@ 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>

Po załadowaniu strony w przeglądarce kliknij przycisk Szczegóły punktu połączenia . Zostaną wyświetlone informacje o punktach połączenia dostawcy i konsumentów ustanowionych w połączeniu deklaratywnym. Następnie użyj kontrolki rozwijanej Tryb wyświetlania , aby przełączyć stronę do trybu łączenia. W menu czasowników kontrolki Dostawca WebPartkodu POCZTOWEgo (reprezentowane przez strzałkę w dół na pasku tytułu) kliknij czasownik połącz. Zostanie wyświetlony interfejs użytkownika połączenia utworzony automatycznie przez kontrolkę <asp:connectionszone> zadeklarowaną na stronie. Jest to inny sposób tworzenia połączenia (za pośrednictwem interfejsu użytkownika) wraz z metodami deklaratywnymi i programowymi omówionymi wcześniej. Kliknij przycisk Rozłącz , aby zakończyć istniejące połączenie statyczne. Kliknij link Utwórz połączenie z użytkownikiem . Interfejs użytkownika wyświetla teraz kontrolkę listy rozwijanej, która wyświetla nazwę wyświetlaną punktu połączenia użytkownika. Wybierz punkt połączenia z listy rozwijanej, a następnie kliknij pozycję Połącz , aby ukończyć połączenie. Następnie kliknij ponownie pozycję Rozłącz . Kliknij przycisk Połączenie dynamiczne , aby programowo utworzyć połączenie. Użyj kontrolki Tryb wyświetlania , aby zwrócić stronę do trybu przeglądania. Kliknij ponownie przycisk Szczegóły punktu połączenia , aby po raz kolejny wskazać szczegóły obiektu punktu połączenia klienta.

W przykładzie pokazano ustanowienie połączenia i użycie punktu połączenia konsumenta na trzy sposoby: statyczne połączenie zadeklarowane w adiustacji strony sieci Web; połączenie utworzone w kodzie, który używał ConsumerConnectionPoint obiektu, oraz połączenie utworzone przez użytkownika za pośrednictwem interfejsu użytkownika połączenia.

Uwagi

W każdym połączeniu składników Web Part między dwoma kontrolkami serwera każda kontrolka musi mieć (między innymi) skojarzony obiekt punktu połączenia, który umożliwia mu nawiązanie połączenia z drugą kontrolką oraz podanie lub użycie danych, w zależności od tego, czy kontrolka jest wyznaczona jako dostawca lub użytkownik połączenia. ConnectionPoint Obiekt w ogóle zawiera szczegółowe informacje dotyczące sposobu łączenia kontrolki z inną kontrolką i typu danych, które mogą być udostępniane. W przypadku kontrolki działającej jako odbiorca w połączeniu jego punkt połączenia musi być obiektem ConsumerConnectionPoint . Aby uzyskać szczegółowe informacje na temat połączeń składników Web Part i punktów połączenia, zapoznaj się z tematami wymienionymi w sekcji Zobacz również poniżej.

Aby utworzyć ConsumerConnectionPoint obiekt, wymagane jest wykonanie kilku kroków:

1. Włącz kontrolkę konsumenta, aby odwoływać się do wystąpienia interfejsu. Kontrolka WebPart lub inny serwer (dowolny typ kontroli serwera, który zostanie dodany do WebPartZoneBase strefy może być używany) musi mieć możliwość korzystania z danych z określonego wystąpienia interfejsu. Kontrolka nie musi implementować interfejsu; tylko dostawca musi go zaimplementować. Użytkownik może pracować z dokładnym typem interfejsu obsługiwanym przez dostawcę lub, jeśli nie, WebPartTransformer obiekt może służyć do przekształcania danych z typu interfejsu dostawcy do typu zrozumiałego przez konsumenta. Typowym sposobem umożliwienia użytkownikowi jest zadeklarowanie pola prywatnego zawierającego odwołanie do żądanego typu interfejsu.

2. Zidentyfikuj metodę wywołania zwrotnego. Metoda w odbiorcy musi zostać zidentyfikowana jako metoda wywołania zwrotnego w celu nawiązania połączenia z dostawcą. Ta metoda pobiera wystąpienie interfejsu implementowania przez dostawcę i przypisuje je do (na przykład) pola prywatnego utworzonego w pierwszym kroku. Podejście składników Web Part do identyfikowania metody wywołania zwrotnego w odbiorcy polega na dodaniu atrybutu metadanych (zdefiniowanego ConnectionConsumerAttribute przez klasęConnectionConsumer) do metody, która odbiera wystąpienie interfejsu. Po dodaniu atrybutu jedynym wymaganym parametrem jest nazwa wyświetlana używana dla punktu połączenia użytkownika. Można również dodać opcjonalne parametry, takie jak identyfikator.

3. Przetwarzaj i wyprowadzaj dane z wystąpienia interfejsu. Wykonaj dowolne wewnętrzne przetwarzanie zgodnie z potrzebami na danych, a następnie zazwyczaj kontrolka konsumenta renderuje dane na stronie. Typowym sposobem wykonania tej czynności jest zastąpienie metody kontrolki OnPreRender .

   Uwaga

   Podczas synchronicznego żądania konsument powinien zażądać danych bezpośrednio od dostawcy podczas lub bezpośrednio po PreRender zdarzeniu. Podczas żądania asynchronicznego, jeśli metoda wywołania zwrotnego dostawcy nie jest wywoływana w żadnym momencie podczas renderowania, deweloper może założyć, że żadne dane nie zostały wysłane do konsumenta.

Po włączeniu kontroli do działania jako konsument kontrola może uczestniczyć w połączeniach (przy założeniu, że kontrola dostawcy jest również wyposażona i dostępna). Aby utworzyć statyczne, deklaratywne połączenie w znacznikach strony internetowej, deweloperzy mogą użyć <asp:webpartconnection> tego elementu. ConnectionConsumer Jeśli atrybut w kodzie źródłowym odbiorcy identyfikujący metodę wywołania zwrotnego określa identyfikator punktu połączenia, ta wartość musi być przypisana do ConsumerConnectionPointID atrybutu <asp:webpartconnection> w elemecie na stronie. Przyczyną, dla którego deweloper może określić identyfikator punktu połączenia użytkownika, jest to, że w kontrolce konsumenta zdefiniowano wiele punktów połączenia. Jeśli identyfikator nie zostanie określony dla punktu połączenia konsumenta w kontrolce konsumenta, wartość nie musi być przypisana do ConsumerConnectionPointID atrybutu na stronie, ponieważ połączenie zostanie utworzone przy użyciu wartości domyślnej uzyskanej DefaultID z pola.

Aby utworzyć połączenie w kodzie, deweloperzy muszą utworzyć nowy ConsumerConnectionPoint obiekt, wywołując GetConsumerConnectionPoints metodę i przekazując do niej identyfikator kontrolki konsumenta, wraz z identyfikatorem lub indeksem zdefiniowanego ConsumerConnectionPoint obiektu w kontrolce konsumenta. Zwrócony ConsumerConnectionPoint obiekt wraz z odwołaniem do kontrolki konsumenta, odwołaniem do kontrolki dostawcy i odpowiadającym mu ProviderConnectionPoint obiektem, są przekazywane do ConnectWebParts metody w celu utworzenia nowego WebPartConnection obiektu.

Chociaż deweloperzy mogą używać punktów połączenia konsumentów w ramach ustanawiania połączeń deklaratywnie lub programowo, użytkownicy mogą również korzystać z punktów połączenia konsumentów w celu nawiązywania połączeń za pośrednictwem interfejsu użytkownika. Jeśli deweloperzy zadeklarują kontrolkę ConnectionsZone na stronie sieci Web, udostępnia interfejs użytkownika czasu wykonywania, który umożliwia użytkownikom tworzenie połączeń. Jeśli użytkownicy wybierają kontrolę dostawcy jako punkt wyjścia do nawiązania połączenia, klikając jego czasownik połączenia (mogą również wybrać konsumenta; nie ma różnicy w wynikowym połączeniu), w interfejsie użytkownika będą widzieć kontrolkę listy rozwijanej z nazwami wyświetlanymi dostępnego punktu połączenia konsumenta (lub punktami, jeśli istnieje wiele), do których dostawca może wysłać dane. Aby nawiązać połączenie, użytkownicy muszą wybrać punkt połączenia użytkownika.

ConsumerConnectionPoint Obiekt kojarzy się bezpośrednio z określoną kontrolką konsumenta i przechowuje szczegółowe informacje o połączeniu we właściwościach dziedziczonej z klasy bazowejConnectionPoint. Na przykład w dziedziczonej InterfaceType właściwości punkt połączenia użytkownika zachowuje typ używanego interfejsu. Jeśli dostawca i odbiorca w połączeniu rozumieją typ interfejsu, kontrolki są zgodne i mogą tworzyć bezpośrednie połączenie. Jeśli dostawca i odbiorca nie mogą pracować z tym samym typem interfejsu, są niezgodne i muszą użyć WebPartTransformer obiektu, aby przetłumaczyć właściwość punktu InterfaceType połączenia dostawcy na typ, z którym użytkownik może pracować. Inną ważną właściwością dziedziczona jest DisplayName właściwość, która zapewnia przyjazną nazwę wyświetlaną w interfejsie użytkownika, aby użytkownicy wybierali punkt połączenia użytkownika podczas tworzenia połączeń. Nazwa wyświetlana jest wymaganym parametrem, gdy deweloperzy dodają ConnectionConsumer atrybut do metody wywołania zwrotnego w kontrolce konsumenta. Dziedziczona ID właściwość jest również przydatna, jak wskazano powyżej, ponieważ udostępnia unikatowy identyfikator punktu połączenia użytkownika w przypadku, gdy użytkownik ma wiele punktów połączenia. Użytkownik może mieć zdefiniowane w nim wiele ConsumerConnectionPoint obiektów, a w tym przypadku, gdy deweloperzy dodają ConnectionConsumer atrybut do metody, powinni określić wartość identyfikatora, aby odróżnić każdy punkt połączenia. Inną godną uwagi właściwością dziedziczona jest AllowsMultipleConnections właściwość, która wskazuje, czy punkt połączenia odbiorcy może łączyć się jednocześnie z wieloma dostawcami. Ta wartość właściwości jest false domyślnie przeznaczona dla punktów połączenia użytkownika (natomiast domyślnie true jest to wartość domyślna dla punktów połączenia dostawcy).

Klasa ConsumerConnectionPoint dodaje kilka unikatowych metod do składowych dziedziczonej ConnectionPoint z klasy. Metoda SetObject wywołuje własną metodę wywołania zwrotnego zdefiniowanego przez użytkownika, aby pobrać wystąpienie interfejsu z dostawcy. Metoda SupportsConnection zwraca wartość logiczną wskazującą, czy punkt połączenia jest w stanie nawiązać połączenia na podstawie bieżącego stanu skojarzonej kontrolki konsumenta.

Konstruktory

ConsumerConnectionPoint(MethodInfo, Type, Type, String, String, Boolean)

Inicjuje nowe wystąpienie klasy ConsumerConnectionPoint.

Właściwości

AllowsMultipleConnections	Pobiera wartość wskazującą, czy punkt połączenia obsługuje wiele równoczesnych połączeń. (Odziedziczone po ConnectionPoint)
ControlType	Type Pobiera kontrolkę serwera, z którą jest skojarzony punkt połączenia. (Odziedziczone po ConnectionPoint)
DisplayName	Pobiera parametry, które służą jako przyjazna nazwa wyświetlana reprezentująca punkt połączenia w interfejsie użytkownika. (Odziedziczone po ConnectionPoint)
ID	Pobiera parametry zawierające identyfikator punktu połączenia. (Odziedziczone po ConnectionPoint)
InterfaceType	Pobiera typ interfejsu używanego przez punkt połączenia. (Odziedziczone po ConnectionPoint)

Metody

Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
GetEnabled(Control)	Zwraca wartość wskazującą, czy punkt połączenia może uczestniczyć w połączeniach. (Odziedziczone po ConnectionPoint)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetType()	Type Pobiera bieżące wystąpienie. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
SetObject(Control, Object)	Wywołuje metodę wywołania zwrotnego w kontrolce konsumenta i pobiera wystąpienie interfejsu z kontrolki dostawcy.
SupportsConnection(Control, ConnectionInterfaceCollection)	Określa, czy punkt połączenia użytkownika jest obecnie w stanie nawiązać połączenie.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)

Zobacz też

• WebPartConnection
• ProviderConnectionPoint
• kontrolki składników Web Part ASP.NET
• Omówienie połączeń składników Web Part