WebPartConnection (Clase)

En el conjunto de controles de elementos web, una conexión es un vínculo o una asociación entre dos controles de WebPart (u otro servidor o usuario) que les permite compartir datos. Esta capacidad de compartir datos permite que los controles conectados se usan de manera que superan la funcionalidad proporcionada por los controles aislados. Por ejemplo, si un control proporciona datos zip, y otro control puede leer estos datos y proporcionar información local de tiempo basada en el código postal, la capacidad conectada de los dos controles proporciona más valor a los usuarios. Para ampliar este ejemplo, otros controles pueden crearse que también muestran información basada en un código postal, como un control con vínculos a noticias local, y todos estos controles que pueden trabajar con datos zip puede compartir datos con el control único que proporciona un código postal. Los usuarios finales de las aplicaciones de elementos web pueden crear y administrar las conexiones entre todos estos controles compatible directamente desde un explorador web, con la interfaz de usuario estándar de las conexiones (UI) que proporciona el control de ConnectionsZone , o mediante una interfaz de usuario personalizada proporcionada por un desarrollador.

Esta información general sobre la clase t WebPartConnection es una instrucción general de detalles básicos para crear una conexión. Para obtener más información sobre los componentes específicos y los requisitos necesarios para crear conexiones, vea Web Parts Connections Overview, o vea clases y ejemplos de código de referencia enumerados en la siguiente descripción. Hay varios aspectos fundamentales de una conexión de elementos web:

• dos controles de WebPart . Cada conexión de elementos web consta de dos controles. Es posible que un control participa en varias conexiones simultáneamente, pero cada conexión consta de exactamente dos controles. Los controles pueden derivar directamente de la clase base de WebPart , o pueden ser otros controles de servidor, incluidos los controles ASP.NET, los controles de servidor personalizados, y los controles de usuario. Los Controles que no se derivan de la clase de WebPart , si están colocados en una zona de WebPartZoneBase , automáticamente se ajustan a un objeto de GenericWebPart en tiempo de ejecución, que les permite heredan de la clase de WebPart y la función como el tiempo de ejecución WebPart controla.

• Controles que se encuentran en las zonas de WebPartZoneBase . Ambos controles de WebPart y cualquier otro tipo de control de servidor deben residir en una zona de WebPartZoneBase para poder participar en conexiones de elementos web (y la mayoría de las otras características de elementos web).

• consumidores y proveedores. En cada conexión de elementos web hay dos controles: un proveedor de datos y de un consumidor de datos. El proveedor proporciona datos al consumidor con un método de devolución de llamada especificado que devuelve datos en forma de interfaz. (Para obtener un ejemplo de cómo crear y especificar el método de devolución de llamada, vea la sección Ejemplo de este tema). Este método de devolución de llamada se conoce como punto de conexión del proveedor. Los detalles de este punto de conexión (el “nombre descriptivo”, un identificador, y el tipo de interfaz devuelta) contenidas en un objeto de ProviderConnectionPoint asociado al control del proveedor. El consumidor recibe los datos con un método especificado que puede aceptar una instancia de interfaz. Este método se conoce como punto de conexión consumidor, y la información de los puntos de conexión (nombre, ID, y el tipo de interfaz) contenidas en un objeto de ConsumerConnectionPoint asociado al control de usuario.

• Controles compatible o un transformador válido. Para una conexión al trabajo, el consumidor y proveedor deben o ser compatibles (significa que los métodos especificados de punto de conexión pueden ejecutar el mismo tipo de interfaz), o debe haber un objeto de WebPartTransformer capaz de convertir el tipo proporcionado por el proveedor en un tipo válido para el consumidor.

• un objeto de WebPartConnection . Para que una conexión existe, debe haber una instancia de la clase de WebPartConnection que contiene referencias al proveedor y controles de usuario, junto con los detalles de los puntos de conexión. Si el proveedor y consumidor son incompatibles y en su lugar utilizan un objeto de WebPartTransformer para conectarse, la conexión hace referencia al transformador.

• significa de establecer la conexión. Una vez que los controles compatibles de consumidor y proveedor se hayan diseñado correctamente con métodos de punto de conexión y se hayan colocado en una zona, y un objeto de WebPartConnection disponible, el paso básico último necesario es iniciar la conexión. Una manera de que esto puede ocurrir es que los usuarios realicen la conexión con la interfaz de usuario. Si se coloca un elemento de <asp:connectionszone> en la página, y otros componentes necesarios para una conexión existen, en tiempo de ejecución que un usuario puede cambiar la página en modo de presentación conectarse, haga clic en un verbo conectarse en el menú de verbos del proveedor o consumidor, y una interfaz de usuario de la conexión (basada en el control de ConnectionsZone ) aparecerá. con esta interfaz de usuario, el usuario puede iniciar la conexión. Otra manera de iniciar la conexión es hacerlo mediante programación. En cualquier caso, si con la interfaz de usuario o mediante programación, el método subyacente que inicia la conexión es igual. La aplicación llama al método de ConnectWebParts (o el método de ConnectWebParts si utiliza un transformador) en el control de WebPartManager , pasando a ella el proveedor, el consumidor, y sus objetos respectivos de punto de conexión, y el método devuelve un objeto de WebPartConnection .

La clase de WebPartConnection define un objeto que encapsula los detalles básicos de una conexión entre dos controles de WebPart . La clase consta casi por completo en las propiedades relacionadas con los detalles de una conexión determinada. Varias propiedades se hacen referencia al control del consumidor en una conexión. La propiedad de Consumer hace referencia al control consumidor propio, y la propiedad de ConsumerID hace referencia al identificador de consumidor El objeto de ConsumerConnectionPoint , que contiene los detalles del punto de conexión consumidor, se hace referencia en la propiedad de ConsumerConnectionPoint de consumidor. La propiedad de ConsumerConnectionPointID hace referencia al identificador de objeto de ConsumerConnectionPoint . todas estas propiedades de conexión relacionadas con el consumador deben tener un valor asignado a ellos para crear una conexión.

La clase de WebPartConnection también tiene varias propiedades relacionadas con el control del proveedor en una conexión, y éstas corresponden a las propiedades de un consumidor. La propiedad de Provider hace referencia al propio control de proveedor, mientras que la propiedad de ProviderID hace referencia al identificador La propiedad de ProviderConnectionPoint hace referencia al objeto de ProviderConnectionPoint , y la propiedad de ProviderConnectionPointID hace referencia al identificador del punto de conexión del proveedor.

Varias propiedades tratan del estado de la conexión. La propiedad de IsActive indica si la conexión activa (actualmente intercambiando datos) o inactivo (aún conectado pero no activamente compartiendo datos). La propiedad de IsShared indica si la conexión es compartido (disponible para todos los usuarios de una página) o una conexión específica, y la propiedad de IsStatic indica si el control es estático (declarado en el marcado de la página y así permanente) o dinámico (creado mediante programación, lo que significa que se puede eliminar).

El ejemplo de código siguiente muestra cómo crear una conexión simple entre dos controles de WebPart . El ejemplo muestra tres mecanismos para formar una conexión: mediante declaración, colocando las etiquetas para la conexión en el marcado de la página Web; mediante programación, creando la conexión en el código; y con la interfaz de usuario, colocando un control de ConnectionsZone en la página, que permite a los usuarios establecer una conexión.

El ejemplo de código tiene cuatro partes:

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

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

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

• Una explicación de cómo trabajar con 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 código fuente siguiente en un archivo .ascx, y recibe el nombre de archivo que se asigna al atributo de Src de la directiva de Register para este control de usuario, que está cerca de la parte superior de la página Web que hospeda. Para obtener más información acerca de los modos de presentación y una descripción del código fuente de este control, vea Walkthrough: Changing Display Modes on a Web Parts Page.

<%@ 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="&nbsp;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 para la interfaz y controles. El archivo de código fuente contiene una interfaz sencilla denominada IZipCode. Hay también una clase de WebPart denominada ZipCodeWebPart que implementa la interfaz y actúa como control del proveedor. El método de ProvideIZipCode es el método de devolución de llamada que implementa el único miembro de interfaz. El método simplemente devuelve una instancia de interfaz. Observe que el método está marcado con un atributo de ConnectionProvider en sus metadatos. Éste es el mecanismo para identificar el método como el método de devolución de llamada para el punto de conexión del proveedor. La otra clase de WebPart se denomina WeatherWebPart, y actúa como consumidor para la conexión. Esta clase tiene un método denominado GetZipCode que obtenga una instancia de la interfaz de IZipCode del control del proveedor. Observe que este método se marca como el método de punto de conexión de consumidor con un atributo de ConnectionConsumer en sus metadatos.

Para ejecutar el ejemplo de código, debe compilar este código fuente. Puede compilar explícitamente y colocar el ensamblado resultante en la caché global de ensamblados de sitio Web la carpeta Bin o. Como alternativa, puede colocar el código fuente en la carpeta App_Code del sitio, donde estará compilada dinámicamente en tiempo de ejecución. Este ejemplo de código se utiliza compilación dinámica. Para un tutorial que muestra cómo compilar, vea Walkthrough: Developing and Using a Custom Server Control.

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 (input.Text != String.Empty)
      {
        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);
    }

  }
}

La tercera parte del ejemplo de código es la página Web. Cerca de la parte superior son las directivas de Register para el control de usuario y controles personalizados de WebPart . Dado que el ejemplo supone la compilación dinámica de los controles, el código fuente de los controles debe estar en una subcarpeta de App_Code; la etiqueta de Register en las referencias de página solo un prefijo de etiqueta arbitrario y el espacio de nombres de los controles. Los controles personalizados de WebPart (el proveedor y consumidor) se declaran dentro del elemento de <asp:webpartzone> de la página Web, dentro de un elemento de <zonetemplate> .

La página proporciona tres mecanismos para formar una conexión entre controles personalizados. el primer método es declarativo. En el marcado de la página, un elemento de <StaticConnections> se declara y, dentro de ese es un elemento de <asp:WebPartConnections> , con varios detalles de consumidor y proveedor de la conexión especificada como atributos. Ésta es una manera de crear una conexión, declarándolo directamente en la página Web, específicamente dentro del elemento de <asp:WebPartManager> . Debido a esta conexión estática, una conexión entre los dos controles personalizados se crea inmediatamente la primera vez que se carga la página.

Un segundo método para formar una conexión entre controles proporcionado por el elemento de <asp:connectionszone> en la página. Si un usuario cambia una página en modo de presentación conectarse en tiempo de ejecución, y haga clic en un verbo conectarse en uno de los controles personalizados, el elemento de <asp:connectionszone> genera automáticamente la interfaz de usuario para crear una conexión.

La página también muestra una tercera alternativa para crear una conexión, que es hacerlo mediante programación. En el método de Button1_Click , el código crea un objeto de ProviderConnectionPoint para el control del proveedor, y recupera sus detalles de punto de conexión llamando al método GetProviderConnectionPoints . Realiza una tarea similar para el control consumidor, llamando al método GetConsumerConnectionPoints . Finalmente, crea el nuevo objeto de WebPartConnection llamando al método ConnectWebParts en el control de WebPartManager .

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

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

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

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

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

Después de cargar la página Web en un explorador, la primera conexión ya existe porque se declara dentro del elemento de <StaticConnections> . Escriba texto en el control de Proveedor de código postal , y se mostrará en el control de usuario. A continuación, desconecta los dos controles. Mediante el control de lista desplegable de Modo de presentacin , cambie la página para conectarse al modo de presentación. Haga clic en el menú de verbos (representado por una flecha abajo de la barra de título) para cada uno de los controles de WebPart , y observe que cada uno tiene una opción de Conectar . Éste es un verbo conectarse, que aparece en el menú de verbos cuando la página está en modo de conexión. Haga clic en el verbo connect en uno de los controles, y la interfaz de usuario de la conexión proporcionada por el control de ConnectionsZone aparece. Haga clic en el botón de Desconectar para finalizar la conexión estática entre los controles. Utilice el control de Modo de presentacin para devolver la página al modo de exploración. Intente escribir algo de nuevo texto en el proveedor de nuevo, y dado que los controles están desconectados, el texto no puede actualizar en el control de usuario.

A continuación, utiliza el mismo método que el anterior para cambiar la página en modo de presentación conectarse de nuevo. Haga clic en un verbo conectarse en uno de los controles. Haga clic en el vínculo de Cree una Conexión , y utilice la interfaz de usuario proporcionada por el control de ConnectionsZone para crear una conexión entre los controles. éste es el segundo método para crear una conexión. Observe que en cuanto se calcula la conexión, la cadena pasada que escribió en el proveedor del control (que podría no aparezcan porque los controles sean desconectado) aparece repentinamente en el consumidor, porque se ha recompilado la conexión. Haga clic en el botón de Desconectar para finalizar la conexión actual que acaba de crear. Devuelve la página al modo de exploración. Escriba algo de nuevo texto en el proveedor para mostrar que el texto no está actualizado, y que los controles están desconectados de nuevo.

Devuelve la página para conectarse al modo de presentación. En lugar de hacer clic en un verbo conectarse, haga clic en el botón de Controles se conectan WebPart , muestra el tercer método para formar una conexión. Este enfoque conecta los controles mediante programación en un paso simple sin tener que utilizar el control de ConnectionsZone . Observe que como se crea la conexión, la cadena pasada que escribió en el proveedor aparece repentinamente en el control de usuario.

.NET Framework

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (no se admite el rol Server Core), Windows Server 2008 R2 (se admite el rol Server Core con SP1 o versiones posteriores; no se admite Itanium)

Referencia

Otros recursos