IWebPartRow Interfaccia
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Definisce un'interfaccia provider per la connessione di due controlli server tramite un singolo campo di dati.
public interface class IWebPartRowpublic interface IWebPartRowtype IWebPartRow = interfacePublic Interface IWebPartRowEsempio
Nell'esempio di codice seguente viene illustrato come creare una connessione statica tra due controlli usando l'interfaccia IWebPartRow . L'esempio di codice include tre parti:
Codice sorgente per due controlli personalizzati WebPart in grado di formare una connessione usando l'interfaccia IWebPartRow , con un controllo che funge da provider e l'altro che funge da consumer.
Pagina Web che ospita i controlli e dichiara la connessione statica in formato di persistenza.
Descrizione di ciò che accade quando viene eseguito il codice di esempio.
La prima parte dell'esempio di codice è il codice sorgente per i due controlli personalizzati. Il primo è il codice per il provider, che implementa l'interfaccia IWebPartRow . Per semplicità nell'esempio, il provider crea una tabella con alcuni dati anziché connettersi a un database. Il GetConnectionInterface metodo funge da punto di connessione del provider, il metodo di callback che restituisce l'istanza dell'interfaccia al consumer. Come per il consumer, recupera l'istanza dell'interfaccia dal provider nel relativo metodo denominato SetConnectionInterface, contrassegnato con un ConnectionConsumer attributo . Dopo aver recuperato l'istanza dell'interfaccia, il consumer, nel relativo OnPreRender metodo, chiama l'implementazione del GetRowData metodo nel provider, per recuperare i dati effettivi e scriverli nella pagina.
Per eseguire l'esempio di codice, è necessario compilare questo codice sorgente. È possibile compilarlo in modo esplicito e inserire l'assembly risultante nella cartella Bin del sito Web o nella Global Assembly Cache. In alternativa, è possibile inserire il codice sorgente nella cartella App_Code del sito, in cui verrà compilato in modo dinamico in fase di esecuzione. In questo esempio di codice viene usata la compilazione dinamica. Per una procedura dettagliata che illustra come eseguire la compilazione, vedere Procedura dettagliata: sviluppo e uso di un controllo server Web personalizzato.
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 row data.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class RowProviderWebPart : WebPart, IWebPartRow
{
private DataTable _table;
public RowProviderWebPart()
{
_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("Row")]
public IWebPartRow GetConnectionInterface()
{
return new RowProviderWebPart();
}
public PropertyDescriptorCollection Schema
{
get
{
return TypeDescriptor.GetProperties(_table.DefaultView[0]);
}
}
public void GetRowData(RowCallback callback)
{
callback(_table.Rows);
}
} // RowProviderWebPart
// This sample code creates a Web Parts control that acts as a consumer
// of row data.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class RowConsumerWebPart : WebPart
{
private IWebPartRow _provider;
private ICollection _tableData;
private void GetRowData(object rowData)
{
_tableData = (ICollection)rowData;
}
protected override void OnPreRender(EventArgs e)
{
if (_provider != null)
{
_provider.GetRowData(new RowCallback(GetRowData));
}
}
protected override void RenderContents(HtmlTextWriter writer)
{
if (_provider != null)
{
PropertyDescriptorCollection props = _provider.Schema;
int count = 0;
if (props != null && props.Count > 0 && _tableData != null)
{
foreach (PropertyDescriptor prop in props)
{
foreach (DataRow o in _tableData)
{
writer.Write(prop.DisplayName + ": " + o[count]);
writer.WriteBreak();
writer.WriteLine();
count = count + 1;
}
}
}
else
{
writer.Write("No data");
}
}
else
{
writer.Write("Not connected");
}
}
[ConnectionConsumer("Row")]
public void SetConnectionInterface(IWebPartRow provider)
{
_provider = provider;
}
} // RowConsumerWebPart
} // 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 row data.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class RowProviderWebPart
Inherits WebPart
Implements IWebPartRow
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("Row")> _
Public Function GetConnectionInterface() As IWebPartRow
Return New RowProviderWebPart()
End Function 'GetConnectionInterface
Public ReadOnly Property Schema() As _
ComponentModel.PropertyDescriptorCollection Implements IWebPartRow.Schema
Get
Return TypeDescriptor.GetProperties(_table.DefaultView(0))
End Get
End Property
Public Sub GetRowData(ByVal callback As RowCallback) _
Implements IWebPartRow.GetRowData
callback(_table.Rows)
End Sub
End Class
' This sample code creates a Web Parts control that acts as a consumer
' of row data.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class RowConsumerWebPart
Inherits WebPart
Private _provider As IWebPartRow
Private _tableData As ICollection
Private Sub GetRowData(ByVal rowData As Object)
_tableData = CType(rowData, ICollection)
End Sub
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
If Not (_provider Is Nothing) Then
_provider.GetRowData(New RowCallback(AddressOf GetRowData))
End If
End Sub
Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
If Not (_provider Is Nothing) Then
Dim props As PropertyDescriptorCollection = _provider.Schema
Dim count As Integer = 0
If Not (props Is Nothing) AndAlso props.Count > 0 _
AndAlso Not (_tableData Is Nothing) Then
Dim prop As PropertyDescriptor
For Each prop In props
Dim o As DataRow
For Each o In _tableData
writer.Write(prop.DisplayName & ": " & o(count))
writer.WriteBreak()
writer.WriteLine()
count = count + 1
Next o
Next prop
Else
writer.Write("No data")
End If
Else
writer.Write("Not connected")
End If
End Sub
<ConnectionConsumer("Row")> _
Public Sub SetConnectionInterface(ByVal provider As IWebPartRow)
_provider = provider
End Sub
End Class
End Namespace ' Samples.AspNet.VB.Controls
La seconda parte dell'esempio di codice è la pagina Web che dichiara la connessione statica e ospita i controlli. Nella parte superiore della pagina è presente una Register direttiva che dichiara lo spazio dei nomi del codice sorgente contenuto nella directory App_Code. La connessione viene dichiarata usando un <asp:webpartconnection> elemento . I controlli consumer e provider personalizzati vengono dichiarati in un elemento all'interno di un <zonetemplate><asp:webpartzone> elemento, che è necessario per potersi connettere (devono risiedere all'interno di una zona che eredita dalla WebPartZoneBase classe ).
<%@ page language="C#" %>
<%@ Register tagprefix="IRow"
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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>IRow Test Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:webpartmanager ID="WebPartManager1" runat="server">
<staticconnections>
<asp:webpartconnection ID="wp1" ProviderID="provider1"
ConsumerID="consumer1">
</asp:webpartconnection>
</staticconnections>
</asp:webpartmanager>
<asp:webpartzone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<irow:RowProviderWebPart ID="provider1" runat="server"
Title="Row Provider Control" />
<irow:RowConsumerWebPart ID="consumer1" runat="server"
Title="Row Consumer Control" />
</ZoneTemplate>
</asp:webpartzone>
</div>
</form>
</body>
</html>
<%@ page language="VB" %>
<%@ Register tagprefix="IRow"
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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>IRow Test Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:webpartmanager ID="WebPartManager1" runat="server">
<staticconnections>
<asp:webpartconnection ID="wp1" ProviderID="provider1"
ConsumerID="consumer1">
</asp:webpartconnection>
</staticconnections>
</asp:webpartmanager>
<asp:webpartzone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<irow:RowProviderWebPart ID="provider1" runat="server"
Title="Row Provider Control" />
<irow:RowConsumerWebPart ID="consumer1" runat="server"
Title="Row Consumer Control" />
</ZoneTemplate>
</asp:webpartzone>
</div>
</form>
</body>
</html>
Caricare la pagina in un browser. Il controllo consumer visualizza i dati forniti dalla riga specificata, che il provider rende disponibile tramite un'istanza dell'interfaccia IWebPartRow .
Commenti
Questa interfaccia è progettata per essere usata con le connessioni web part. In una connessione web part, due controlli server che risiedono in una WebPartZoneBase zona stabiliscono una connessione e condividono i dati, con un controllo che funge da consumer e l'altro controllo che funge da provider. Il meccanismo per la condivisione dei dati in una connessione web part è un'istanza di interfaccia, che il provider serve al consumer tramite un metodo di callback. Per stabilire una connessione, il consumer e il provider devono entrambi funzionare con lo stesso tipo di interfaccia per la condivisione dei dati. Se il consumer non riconosce il tipo di interfaccia inviato dal provider, è comunque possibile connettere i controlli tramite un trasformatore (oggetto WebPartTransformer ) che converte l'istanza di interfaccia inviata dal provider in un tipo riconosciuto dal consumer. Per informazioni dettagliate sulle connessioni, vedere WebPartConnection Panoramica delle connessioni web part.
L'interfaccia IWebPartRow è un'interfaccia del provider inclusa nel set di controlli Web part come interfaccia standard per la creazione di connessioni basate su una riga di dati. È anche possibile creare interfacce personalizzate da usare con le connessioni web part, ma in molte applicazioni Web guidate dai dati è utile creare connessioni basate su un campo comune (per informazioni dettagliate, vedere l'interfaccia IWebPartField ), tabella (per informazioni dettagliate, vedere l'interfaccia IWebPartTable ) o riga dall'origine dati. In una connessione tipica, un WebPart controllo che funge da provider implementa l'interfaccia IWebPartRow e fornisce un'istanza dell'interfaccia ai consumer in un metodo di callback speciale. Ad esempio, il provider potrebbe implementare un'interfaccia IWebPartRow per una riga che corrisponde a un utente nella tabella delle informazioni utente. Un altro WebPart controllo che funge da consumer definisce un metodo speciale per ricevere l'istanza dell'interfaccia e può quindi estrarre i dati utente, usarlo per cercare informazioni aggiuntive sugli account dell'utente e visualizzare tutte le informazioni correlate a tale utente nella pagina.
L'interfaccia IWebPartRow ha due membri esposti. La Schema proprietà restituisce informazioni sullo schema sulla riga di dati incapsulata in un PropertyDescriptorCollection oggetto . Il GetRowData metodo dichiara un metodo usato da un implementatore (ad esempio un controllo provider) per recuperare i dati di riga dell'istanza dell'interfaccia quando viene richiamato il metodo di callback.
Proprietà
| Schema |
Ottiene le informazioni sullo schema per una riga di dati utilizzata per condividere i dati tra due controlli WebPart. |
Metodi
| GetRowData(RowCallback) |
Restituisce i dati per la riga utilizzata dall'interfaccia come base della connessione tra due controlli WebPart. |
