ConsumerConnectionPoint Clase

Definición

Espacio de nombres:

System.Web.UI.WebControls.WebParts

Ensamblado:

System.Web.dll

Define un objeto de punto de conexión que permite a un control de servidor que actúa como consumidor establecer una conexión con un proveedor.

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

Herencia

Object

ConnectionPoint

ConsumerConnectionPoint

Ejemplos

En el ejemplo de código siguiente se muestran formas sencillas de crear una conexión mediante declaración, mediante programación o a través de la interfaz de usuario, en cada caso haciendo uso de un punto de conexión de consumidor.

El ejemplo tiene cuatro partes:

• Control de usuario que permite cambiar el modo de presentación de elementos web en una página.

• Código fuente de una interfaz y dos WebPart controles que actúan como proveedor y consumidor para una conexión.

• Una página web para hospedar todos los controles y ejecutar el ejemplo de código.

• Explicación de cómo ejecutar la página de ejemplo.

La primera parte de este ejemplo de código es el control de usuario que permite a los usuarios cambiar los modos de presentación en una página web. Guarde el siguiente código fuente en un archivo .ascx y asígnele el nombre de archivo asignado al Src atributo de la Register directiva para este control de usuario, que está cerca de la parte superior de la página web de hospedaje. Para obtener más información sobre los modos de visualización y una descripción del código fuente de este control, vea Tutorial: Cambiar modos de presentación en una página de elementos web.

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

La segunda parte del ejemplo de código es el código fuente de la interfaz y los controles. El archivo de origen contiene una interfaz simple denominada IZipCode. También hay una WebPart clase denominada ZipCodeWebPart que implementa la interfaz y actúa como control de proveedor. La otra WebPart clase se denomina WeatherWebParty actúa como consumidor de la conexión. Esta clase tiene un método denominado GetZipCode que obtiene una instancia de la IZipCode interfaz del control de proveedor. Tenga en cuenta que este método se marca como método de punto de conexión del consumidor con un ConnectionConsumer atributo en sus metadatos. Este es el mecanismo para identificar el método de punto de conexión en el control de consumidor.

Para que se ejecute el ejemplo de código, debe compilar este código fuente. Puede compilarlo explícitamente y colocar el ensamblado resultante en la carpeta Bin del sitio web o en la caché global de ensamblados. Como alternativa, puede colocar el código fuente en la carpeta App_Code del sitio, donde se compilará dinámicamente en tiempo de ejecución. En este ejemplo de código se usa la compilación dinámica. Para ver un tutorial que muestra cómo compilar, consulte Tutorial: Desarrollo y uso de un control de servidor web personalizado.

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

La tercera parte del ejemplo de código es la página web. Cerca de la parte superior hay Register directivas para registrar los controles personalizados que forman la conexión y el control de usuario que permite a los usuarios cambiar los modos de visualización en la página. La propia conexión se crea declarativamente dentro del <staticconnections> elemento de la página. Esto muestra una manera de crear una conexión, tenga en cuenta el ConsumerConnectionPointID atributo en el <asp:webpartconnection> elemento . También puede crear la conexión mediante programación; el código para hacerlo está en el Button1_Click método . En este caso, se crea un ConsumerConnectionPoint objeto y, a continuación, se pasa a un método que crea la conexión real. Tanto si la conexión se crea mediante declaración como mediante programación, siempre se deben especificar puntos de conexión para el proveedor y el consumidor. El Button2_Click método tiene acceso a los ConnectionPoint objetos tanto para el proveedor como para el consumidor, y escribe algunos de sus valores de propiedad en una etiqueta de la página.

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

Después de cargar la página en un explorador, haga clic en el botón Detalles del punto de conexión . Aparece información sobre los puntos de conexión de proveedor y consumidor establecidos en la conexión declarativa. A continuación, use el control desplegable Modo de visualización para cambiar la página al modo de conexión. En el menú de verbos del control Proveedor WebPart de código postal (representado por una flecha hacia abajo en la barra de título), haga clic en el verbo connect. Aparece la interfaz de usuario de conexión, creada automáticamente por el <asp:connectionszone> control declarado en la página. Esta es otra manera de crear una conexión (a través de la interfaz de usuario), junto con los métodos declarativos y programáticos descritos anteriormente. Haga clic en el botón Desconectar para finalizar la conexión estática existente. Haga clic en el vínculo Crear una conexión a un consumidor . La interfaz de usuario ahora muestra un control desplegable que muestra el nombre para mostrar del punto de conexión del consumidor. Seleccione el punto de conexión en la lista desplegable y, a continuación, haga clic en Conectar para completar la conexión. A continuación, haga clic en Desconectar de nuevo. Haga clic en el botón Conexión dinámica para crear una conexión mediante programación. Use el control Modo de presentación para devolver la página para examinar el modo. Vuelva a hacer clic en el botón Detalles del punto de conexión para indicar detalles sobre el objeto de punto de conexión de consumidor una vez más.

El ejemplo ha demostrado establecer una conexión y usar un punto de conexión de consumidor de tres maneras: una conexión estática declarada en el marcado de página web; una conexión creada en el código que usó un ConsumerConnectionPoint objeto y una conexión creada por un usuario a través de la interfaz de usuario de conexión.

Comentarios

En cada conexión de elementos web entre dos controles de servidor, cada control debe tener (entre otros requisitos) un objeto de punto de conexión asociado que le permita conectarse al otro control y proporcionar o consumir datos, dependiendo de si el control se designa como proveedor o consumidor para la conexión. Un ConnectionPoint objeto en general contiene los detalles sobre cómo un control puede conectarse a otro control y el tipo de datos que puede compartir. Para un control que actúa como consumidor en una conexión, su punto de conexión debe ser un ConsumerConnectionPoint objeto . Para obtener más información sobre las conexiones de elementos web y los puntos de conexión, lea los temas enumerados en la sección Ver también a continuación.

Para crear un ConsumerConnectionPoint objeto, se requieren varios pasos:

1. Habilite un control de consumidor para hacer referencia a una instancia de interfaz. Un WebPart control de servidor u otro (cualquier tipo de control de servidor que se agregará a una WebPartZoneBase zona se puede usar) debe poder consumir datos de una instancia de interfaz específica. El control no necesita implementar la interfaz; solo el proveedor debe implementarlo. El consumidor puede trabajar con el tipo de interfaz exacto servido por un proveedor o, si no lo hace, se puede usar un WebPartTransformer objeto para transformar los datos del tipo de interfaz de un proveedor a un tipo comprendido por el consumidor. Una manera típica de habilitar un consumidor es declarar un campo privado para que contenga una referencia al tipo de interfaz deseado.

2. Identifique un método de devolución de llamada. Se debe identificar un método en el consumidor como método de devolución de llamada para establecer una conexión con el proveedor. Este método recupera una instancia de la interfaz que implementa el proveedor y la asigna al campo privado (por ejemplo) creado en el primer paso. El enfoque de elementos web para identificar un método de devolución de llamada en el consumidor es agregar un ConnectionConsumer atributo de metadatos (definido por la ConnectionConsumerAttribute clase) al método que recibe la instancia de interfaz. Cuando se agrega el atributo , el único parámetro necesario es un nombre para mostrar que se usará para el punto de conexión del consumidor. También se pueden agregar parámetros opcionales, como un identificador.

3. Procesar y generar los datos de la instancia de interfaz. Realice cualquier procesamiento interno según sea necesario en los datos y, después, normalmente un control de consumidor representará los datos en la página. Una forma habitual de hacerlo es invalidar el método del OnPreRender control.

   Nota

   Durante una solicitud sincrónica, un consumidor debe solicitar datos directamente desde el proveedor durante o inmediatamente después del PreRender evento. Durante una solicitud asincrónica, si no se llama al método de devolución de llamada del proveedor en ningún momento durante la representación, el desarrollador puede suponer que no se envió ningún dato al consumidor.

Después de que un control se haya equipado para actuar como consumidor, el control puede participar en conexiones (suponiendo que un control de proveedor también esté equipado y disponible). Para crear una conexión estática declarativa en el marcado de una página web, los desarrolladores pueden usar el <asp:webpartconnection> elemento . Si el ConnectionConsumer atributo del código fuente del consumidor que identifica el método de devolución de llamada especifica un identificador para el punto de conexión, ese valor debe asignarse al ConsumerConnectionPointID atributo del elemento de <asp:webpartconnection> una página. Un motivo por el que un desarrollador puede especificar un identificador para un punto de conexión de consumidor es si hay varios puntos de conexión definidos en el control de consumidor. Si no se especifica un identificador para el punto de conexión de consumidor en el control de consumidor, no es necesario asignar un valor al ConsumerConnectionPointID atributo de la página, ya que la conexión se creará con un valor predeterminado obtenido del DefaultID campo.

Para crear una conexión en el código, los desarrolladores deben crear un nuevo ConsumerConnectionPoint objeto llamando al GetConsumerConnectionPoints método y pasandolo al identificador del control de consumidor, junto con el identificador o índice del objeto definido ConsumerConnectionPoint en el control de consumidor. El objeto devuelto ConsumerConnectionPoint , junto con una referencia al control de consumidor, una referencia al control de proveedor y un objeto correspondiente ProviderConnectionPoint , se pasan al ConnectWebParts método para crear un nuevo WebPartConnection objeto.

Aunque los desarrolladores pueden usar puntos de conexión de consumidor como parte del establecimiento de conexiones mediante declaración o mediante programación, los usuarios también pueden interactuar con los puntos de conexión de consumidor para establecer conexiones a través de la interfaz de usuario (UI). Si los desarrolladores declaran un ConnectionsZone control en una página web, proporciona una interfaz de usuario en tiempo de ejecución para que los usuarios creen conexiones. Si los usuarios eligen el control de proveedor como punto de partida para establecer la conexión haciendo clic en su verbo connect (también pueden elegir el consumidor; no hay ninguna diferencia en la conexión resultante), en la interfaz de usuario verán un control de lista desplegable con los nombres para mostrar del punto de conexión de consumidor disponible (o puntos si hay varios) a los que el proveedor puede enviar los datos. Los usuarios deben seleccionar un punto de conexión de consumidor para establecer una conexión.

Un ConsumerConnectionPoint objeto se asocia directamente a un control de consumidor específico y almacena detalles sobre una conexión en las propiedades que hereda de la clase base ConnectionPoint . Por ejemplo, en la propiedad heredada InterfaceType , un punto de conexión de consumidor mantiene el tipo de interfaz que usa. Si el proveedor y el consumidor de una conexión comprenden el tipo de interfaz, los controles son compatibles y pueden formar una conexión directa. Si el proveedor y el consumidor no pueden trabajar con el mismo tipo de interfaz, no son compatibles y deben usar un WebPartTransformer objeto para convertir la propiedad del punto de conexión del InterfaceType proveedor en un tipo con el que el consumidor pueda trabajar. Otra propiedad heredada importante es la DisplayName propiedad , que proporciona un nombre descriptivo para mostrar en la interfaz de usuario para que los usuarios elijan un punto de conexión de consumidor al crear conexiones. El nombre para mostrar es el parámetro necesario cuando los desarrolladores agregan un ConnectionConsumer atributo al método de devolución de llamada en un control de consumidor. La propiedad heredada ID también es útil, como se indicó anteriormente, porque proporciona un identificador único para un punto de conexión de consumidor en caso de que un consumidor tenga varios puntos de conexión. Un consumidor puede tener varios ConsumerConnectionPoint objetos definidos en él y, en este caso, cuando los desarrolladores agregan el ConnectionConsumer atributo a un método, deben especificar un valor de identificador para distinguir cada punto de conexión. Otra propiedad heredada notable es la AllowsMultipleConnections propiedad , que indica si un punto de conexión de consumidor puede conectarse simultáneamente a varios proveedores. Este valor de propiedad es false de forma predeterminada para los puntos de conexión de consumidor (mientras que el valor predeterminado es para los true puntos de conexión del proveedor).

La ConsumerConnectionPoint clase agrega varios métodos únicos a los miembros que hereda de la ConnectionPoint clase . El SetObject método invoca el propio método de devolución de llamada definido del consumidor para recuperar la instancia de interfaz del proveedor. El SupportsConnection método devuelve un valor booleano que indica si el punto de conexión puede establecer conexiones, en función del estado actual del control de consumidor asociado.

Constructores

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

Inicializa una nueva instancia de la clase ConsumerConnectionPoint.

Propiedades

AllowsMultipleConnections	Obtiene un valor que indica si un punto de conexión admite varias conexiones simultáneas. (Heredado de ConnectionPoint)
ControlType	Obtiene el tipo Type del control de servidor al que se asocia un punto de conexión. (Heredado de ConnectionPoint)
DisplayName	Obtiene una cadena que actúa como nombre descriptivo que representa un punto de conexión en la interfaz de usuario. (Heredado de ConnectionPoint)
ID	Obtiene una cadena que contiene el identificador de un punto de conexión. (Heredado de ConnectionPoint)
InterfaceType	Obtiene el tipo de interfaz utilizado por un punto de conexión. (Heredado de ConnectionPoint)

Métodos

Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetEnabled(Control)	Devuelve un valor que indica si un punto de conexión puede participar en conexiones. (Heredado de ConnectionPoint)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
SetObject(Control, Object)	Invoca el método de devolución de llamada en un control consumidor y recupera la instancia de interfaz de un control proveedor.
SupportsConnection(Control, ConnectionInterfaceCollection)	Determina si un punto de conexión del consumidor es capaz en la actualidad de establecer una conexión.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Consulte también

• WebPartConnection
• ProviderConnectionPoint
• controles de elementos web de ASP.NET
• Introducción a las conexiones de elementos web