IWebPartField Interfaz
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Define una interfaz de proveedor para conectar dos controles de servidor mediante un único campo de datos.
public interface class IWebPartFieldpublic interface IWebPartFieldtype IWebPartField = interfacePublic Interface IWebPartField- Derivado
Ejemplos
En el ejemplo de código siguiente se muestra cómo crear una conexión estática entre dos controles mediante la IWebPartField interfaz . El ejemplo de código tiene tres partes:
Código fuente para dos controles personalizados WebPart que pueden formar una conexión mediante la IWebPartField interfaz , con un control que actúa como proveedor, el otro actúa como consumidor.
Página web que hospeda los controles y declara la conexión estática en formato de persistencia.
Descripción de lo que sucede cuando se ejecuta el código de ejemplo.
La primera parte del ejemplo de código es el código fuente de los dos controles personalizados. En primer lugar, es el código del proveedor, que implementa la IWebPartField interfaz . Por motivos de simplicidad en el ejemplo, el proveedor crea una tabla con algunos datos en lugar de conectarse a una base de datos. El GetConnectionInterface método actúa como punto de conexión del proveedor, el método de devolución de llamada que devuelve la instancia de interfaz al consumidor. En cuanto al consumidor, recupera la instancia de interfaz del proveedor en su método denominado SetConnectionInterface, que se marca con un ConnectionConsumer atributo . Después de recuperar la instancia de la interfaz, el consumidor, en su OnPreRender método, llama a la implementación del GetFieldValue método en el proveedor para recuperar los datos reales.
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, vea Tutorial: Desarrollo y uso de un control de servidor web personalizado.
using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
namespace Samples.AspNet.CS.Controls
{
// This sample code creates a Web Parts control that acts as a provider
// of field data.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class FieldProviderWebPart : WebPart, IWebPartField
{
private DataTable _table;
public FieldProviderWebPart()
{
_table = new DataTable();
DataColumn col = new DataColumn();
col.DataType = typeof(string);
col.ColumnName = "Name";
_table.Columns.Add(col);
col = new DataColumn();
col.DataType = typeof(string);
col.ColumnName = "Address";
_table.Columns.Add(col);
col = new DataColumn();
col.DataType = typeof(int);
col.ColumnName = "ZIP Code";
_table.Columns.Add(col);
DataRow row = _table.NewRow();
row["Name"] = "John Q. Public";
row["Address"] = "123 Main Street";
row["ZIP Code"] = 98000;
_table.Rows.Add(row);
}
[ConnectionProvider("FieldProvider")]
public IWebPartField GetConnectionInterface()
{
return new FieldProviderWebPart();
}
public PropertyDescriptor Schema
{
get
{
/* The two parameters are row and field. Zero is the first record.
0,2 returns the zip code field value. */
return TypeDescriptor.GetProperties(_table.DefaultView[0])[2];
}
}
void IWebPartField.GetFieldValue(FieldCallback callback)
{
callback(Schema.GetValue(_table.DefaultView[0]));
}
} // end FieldProviderWebPart
// This sample code creates a Web Parts control that acts as a consumer
// of an IWebPartField interface.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class FieldConsumerWebPart : WebPart
{
private IWebPartField _provider;
private object _fieldValue;
private void GetFieldValue(object fieldValue)
{
_fieldValue = fieldValue;
}
public bool ConnectionPointEnabled
{
get
{
object o = ViewState["ConnectionPointEnabled"];
return (o != null) ? (bool)o : true;
}
set
{
ViewState["ConnectionPointEnabled"] = value;
}
}
protected override void OnPreRender(EventArgs e)
{
if (_provider != null)
{
_provider.GetFieldValue(new FieldCallback(GetFieldValue));
}
base.OnPreRender(e);
}
protected override void RenderContents(HtmlTextWriter writer)
{
if (_provider != null)
{
PropertyDescriptor prop = _provider.Schema;
if (prop != null && _fieldValue != null)
{
writer.Write(prop.DisplayName + ": " + _fieldValue);
}
else
{
writer.Write("No data");
}
}
else
{
writer.Write("Not connected");
}
}
[ConnectionConsumer("FieldConsumer", "Connpoint1",
typeof(FieldConsumerConnectionPoint), AllowsMultipleConnections = true)]
public void SetConnectionInterface(IWebPartField provider)
{
_provider = provider;
}
public class FieldConsumerConnectionPoint : ConsumerConnectionPoint
{
public FieldConsumerConnectionPoint(MethodInfo callbackMethod,
Type interfaceType, Type controlType, string name, string id,
bool allowsMultipleConnections)
: base(
callbackMethod, interfaceType, controlType,
name, id, allowsMultipleConnections)
{
}
public override bool GetEnabled(Control control)
{
return ((FieldConsumerWebPart)control).ConnectionPointEnabled;
}
} // end FieldConsumerConnectionPoint
} // end FieldConsumerWebPart
} // end namespace Samples.AspNet.CS.Controls
Imports System.Collections
Imports System.ComponentModel
Imports System.Data
Imports System.Reflection
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
' This sample code creates a Web Parts control that acts as a
' provider of field data.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class FieldProviderWebPart
Inherits WebPart
Implements IWebPartField
Private _table As DataTable
Public Sub New()
_table = New DataTable()
Dim col As New DataColumn()
col.DataType = GetType(String)
col.ColumnName = "Name"
_table.Columns.Add(col)
col = New DataColumn()
col.DataType = GetType(String)
col.ColumnName = "Address"
_table.Columns.Add(col)
col = New DataColumn()
col.DataType = GetType(Integer)
col.ColumnName = "ZIP Code"
_table.Columns.Add(col)
Dim row As DataRow = _table.NewRow()
row("Name") = "John Q. Public"
row("Address") = "123 Main Street"
row("ZIP Code") = 98000
_table.Rows.Add(row)
End Sub
<ConnectionProvider("FieldProvider")> _
Public Function GetConnectionInterface() As IWebPartField
Return New FieldProviderWebPart()
End Function
Public ReadOnly Property Schema() As ComponentModel.PropertyDescriptor _
Implements IWebPartField.Schema
Get
' The two parameters are row and field. Zero is the first record.
' 0,2 returns the zip code field value.
Return TypeDescriptor.GetProperties(_table.DefaultView(0))(2)
End Get
End Property
Sub GetFieldValue(ByVal callback As FieldCallback) _
Implements IWebPartField.GetFieldValue
callback(Schema.GetValue(_table.DefaultView(0)))
End Sub
End Class
' This sample code creates a Web Parts control that acts as a
' consumer of an IWebPartField interface.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class FieldConsumerWebPart
Inherits WebPart
Private _provider As IWebPartField
Private _fieldValue As Object
Private Sub GetFieldValue(ByVal fieldValue As Object)
_fieldValue = fieldValue
End Sub
Public Property ConnectionPointEnabled() As Boolean
Get
Dim o As Object = ViewState("ConnectionPointEnabled")
Return IIf(Not (o Is Nothing), CBool(o), True)
End Get
Set(ByVal value As Boolean)
ViewState("ConnectionPointEnabled") = value
End Set
End Property
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
If Not (_provider Is Nothing) Then
_provider.GetFieldValue(New FieldCallback(AddressOf GetFieldValue))
End If
MyBase.OnPreRender(e)
End Sub
Protected Overrides Sub RenderContents(ByVal writer As _
HtmlTextWriter)
If Not (_provider Is Nothing) Then
Dim prop As PropertyDescriptor = _provider.Schema
If Not (prop Is Nothing) AndAlso Not (_fieldValue Is Nothing) Then
writer.Write(prop.DisplayName & ": " & _fieldValue)
Else
writer.Write("No data")
End If
Else
writer.Write("Not connected")
End If
End Sub
<ConnectionConsumer("FieldConsumer", "Connpoint1", _
GetType(FieldConsumerConnectionPoint), AllowsMultipleConnections:=True)> _
Public Sub SetConnectionInterface(ByVal provider As IWebPartField)
_provider = provider
End Sub
End Class
Public Class FieldConsumerConnectionPoint
Inherits ConsumerConnectionPoint
Public Sub New(ByVal callbackMethod As MethodInfo, _
ByVal interfaceType As Type, ByVal controlType As Type, _
ByVal name As String, ByVal id As String, _
ByVal allowsMultipleConnections As Boolean)
MyBase.New(callbackMethod, interfaceType, controlType, _
name, id, allowsMultipleConnections)
End Sub
Public Overrides Function GetEnabled(ByVal control As Control) _
As Boolean
Return CType(control, FieldConsumerWebPart).ConnectionPointEnabled
End Function
End Class
End Namespace ' Samples.AspNet.VB.Controls
La segunda parte del ejemplo de código es la página web que declara la conexión estática y hospeda los controles. Cerca de la parte superior de la página hay una Register directiva que declara el espacio de nombres del código fuente contenido en el directorio App_Code. La conexión se declara mediante un <asp:webpartconnection> elemento . Los controles de consumidor y proveedor personalizados se declaran en un <zonetemplate> elemento dentro de un <asp:webpartzone> elemento , que es necesario para que puedan conectarse (deben residir dentro de una zona que hereda de la WebPartZoneBase clase ).
<%@ page language="C#" %>
<%@ Register tagprefix="IField"
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">
<!-- This code sample creates a page with two Web Parts controls
and establishes a connection between the controls. -->
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>IWebPartField Test Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:webpartmanager id="WebPartManager1" runat="server">
<StaticConnections>
<asp:WebPartConnection id="con1" ProviderID="provider1"
ConsumerID="consumer1"
ConsumerConnectionPointID="Connpoint1">
</asp:WebPartConnection>
</StaticConnections>
</asp:webpartmanager>
<asp:webpartzone id="WebPartZone1" runat="server">
<zoneTemplate>
<ifield:fieldproviderwebpart runat="Server"
ID="provider1" Title="Provider" />
<ifield:fieldconsumerwebpart runat="Server"
ID="consumer1" Title="Consumer"/>
</zoneTemplate>
</asp:webpartzone>
</div>
</form>
</body>
</html>
<%@ page language="VB" debug="true" %>
<%@ Register tagprefix="IField"
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">
<!-- This code sample creates a page with two Web Parts controls
and establishes a connection between the controls. -->
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>IWebPartField Test Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:webpartmanager id="WebPartManager1" runat="server">
<StaticConnections>
<asp:WebPartConnection id="con1" ProviderID="provider1"
ConsumerID="consumer1"
ConsumerConnectionPointID="Connpoint1">
</asp:WebPartConnection>
</StaticConnections>
</asp:webpartmanager>
<asp:webpartzone id="WebPartZone1" runat="server">
<zoneTemplate>
<ifield:fieldproviderwebpart runat="Server"
ID="provider1" Title="Provider" />
<ifield:fieldconsumerwebpart runat="Server"
ID="consumer1" Title="Consumer"/>
</zoneTemplate>
</asp:webpartzone>
</div>
</form>
</body>
</html>
Cargue la página en un explorador. El control de consumidor muestra los datos proporcionados desde el campo especificado, que el proveedor pone a disposición a través de una instancia de la IWebPartField interfaz .
Comentarios
Esta interfaz está diseñada para usarse con conexiones de elementos web. En una conexión de elementos web, dos controles de servidor que residen en una WebPartZoneBase zona establecen una conexión y comparten datos, con un control que actúa como consumidor y el otro control que actúa como proveedor. El mecanismo para compartir datos en una conexión de elementos web es una instancia de interfaz, que el proveedor sirve al consumidor mediante un método de devolución de llamada. Para establecer una conexión, el consumidor y el proveedor deben trabajar con el mismo tipo de interfaz para compartir datos. Si el consumidor no reconoce el tipo de interfaz enviado por el proveedor, sigue siendo posible conectar los controles mediante un transformador (un WebPartTransformer objeto) que traduce la instancia de interfaz enviada por el proveedor a un tipo que reconoce el consumidor. Para obtener más información sobre las conexiones, consulte WebPartConnection y Introducción a las conexiones de elementos web.
La IWebPartField interfaz es una interfaz de proveedor incluida con el control de elementos web establecido como una interfaz estándar para crear conexiones basadas en un campo de datos. También puede crear interfaces personalizadas para usarlas con conexiones de elementos web, pero en muchas aplicaciones web controladas por datos, resulta útil crear conexiones basadas en una fila común (para obtener más información, consulte la IWebPartRow interfaz), tabla (para obtener más información, ver la IWebPartTable interfaz) o campo desde el origen de datos mediante la IWebPartField interfaz . En una conexión típica, un WebPart control que actúa como proveedor implementaría la IWebPartField interfaz y proporcionaría una instancia de la interfaz a los consumidores en un método de devolución de llamada especial. Por ejemplo, el proveedor podría implementar una IWebPartField interfaz para un campo de la tabla de información de usuario que contiene los datos de código postal de un usuario web. Otro WebPart control que actúa como consumidor definiría un método especial para recibir la instancia de interfaz y, a continuación, podría extraer los datos del código postal y buscar y mostrar información meteorológica basada en el código postal.
La IWebPartField interfaz tiene dos miembros expuestos. La Schema propiedad devuelve información de esquema sobre el campo de datos encapsulado en un PropertyDescriptor objeto . El GetFieldValue método declara un método que un implementador (como un control de proveedor) usa para recuperar los datos de campo de la instancia de interfaz cuando se invoca el método de devolución de llamada.
Propiedades
| Schema |
Obtiene la información del esquema de un campo de datos que se utiliza para compartir los datos entre dos controles WebPart. |
Métodos
| GetFieldValue(FieldCallback) |
Devuelve el valor del campo que la interfaz está utilizando como base de una conexión entre dos controles WebPart. |
