IWebPartTable Rozhraní
Definice
Důležité
Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.
Definuje rozhraní zprostředkovatele pro propojení dvou serverových ovládacích prvků pomocí celé tabulky dat.
public interface class IWebPartTablepublic interface IWebPartTabletype IWebPartTable = interfacePublic Interface IWebPartTablePříklady
Následující příklad kódu ukazuje, jak vytvořit statické připojení mezi dvěma ovládacími prvky pomocí IWebPartTable rozhraní. Příklad kódu má tři části:
Zdrojový kód pro dva vlastní WebPart ovládací prvky, které mohou vytvořit připojení pomocí IWebPartTable rozhraní, přičemž jeden ovládací prvek funguje jako zprostředkovatel a druhý jako příjemce.
Webová stránka, která je hostitelem ovládacích prvků a deklaruje statické připojení ve formátu trvalosti.
Popis toho, co se stane při spuštění ukázkového kódu.
První část příkladu kódu je zdrojový kód pro dva vlastní ovládací prvky. První je kód pro zprostředkovatele, který implementuje IWebPartTable rozhraní. Pro zjednodušení v příkladu vytvoří zprostředkovatel tabulku s některými daty místo připojení k databázi. Metoda GetConnectionInterface slouží jako spojovací bod poskytovatele, metoda zpětného volání, která vrací instanci rozhraní příjemci. Pokud jde o příjemce, načte instanci rozhraní od poskytovatele ve své metodě s názvem SetConnectionInterface, která je označena atributem ConnectionConsumer . Po načtení instance rozhraní příjemce ve své OnPreRender metodě zavolá implementaci GetTableData metody ve zprostředkovatele, aby načetl skutečná data a zapíše je na stránku.
Aby se příklad kódu spustil, musíte tento zdrojový kód zkompilovat. Můžete ho explicitně zkompilovat a umístit výsledné sestavení do složky Bin webu nebo globální mezipaměti sestavení . Případně můžete zdrojový kód umístit do složky App_Code webu, kde se bude dynamicky kompilovat za běhu. Tento příklad kódu používá dynamickou kompilaci. Návod, který ukazuje, jak kompilovat, najdete v tématu Návod: Vývoj a použití vlastního ovládacího prvku webového serveru.
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 table data.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class TableProviderWebPart : WebPart, IWebPartTable
{
DataTable _table;
public TableProviderWebPart()
{
_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);
}
public PropertyDescriptorCollection Schema
{
get
{
return TypeDescriptor.GetProperties(_table.DefaultView[0]);
}
}
public void GetTableData(TableCallback callback)
{
callback(_table.Rows);
}
public bool ConnectionPointEnabled
{
get
{
object o = ViewState["ConnectionPointEnabled"];
return (o != null) ? (bool)o : true;
}
set
{
ViewState["ConnectionPointEnabled"] = value;
}
}
[ConnectionProvider("Table", typeof(TableProviderConnectionPoint),
AllowsMultipleConnections = true)]
public IWebPartTable GetConnectionInterface()
{
return new TableProviderWebPart();
}
public class TableProviderConnectionPoint : ProviderConnectionPoint
{
public TableProviderConnectionPoint(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 ((TableProviderWebPart)control).ConnectionPointEnabled;
}
}
}
// This code sample creates a Web Parts control that acts as a consumer
// of information provided by the TableProvider.ascx control.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class TableConsumer : WebPart
{
private IWebPartTable _provider;
private ICollection _tableData;
private void GetTableData(object tableData)
{
_tableData = (ICollection)tableData;
}
protected override void OnPreRender(EventArgs e)
{
if (_provider != null)
{
_provider.GetTableData(new TableCallback(GetTableData));
}
}
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("Table")]
public void SetConnectionInterface(IWebPartTable provider)
{
_provider = provider;
}
public class TableConsumerConnectionPoint : ConsumerConnectionPoint
{
public TableConsumerConnectionPoint(MethodInfo callbackMethod,
Type interfaceType, Type controlType, string name, string id,
bool allowsMultipleConnections)
: base(callbackMethod, interfaceType, controlType, name, id,
allowsMultipleConnections)
{
}
} // TableConsumerConnectionPoint
} // TableConsumer
} // 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 table data.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public NotInheritable Class TableProviderWebPart
Inherits WebPart
Implements IWebPartTable
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
Public ReadOnly Property Schema() As _
ComponentModel.PropertyDescriptorCollection Implements IWebPartTable.Schema
Get
Return TypeDescriptor.GetProperties(_table.DefaultView(0))
End Get
End Property
Public Sub GetTableData(ByVal callback As TableCallback) _
Implements IWebPartTable.GetTableData
callback(_table.Rows)
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
<ConnectionProvider("Table", GetType(TableProviderConnectionPoint), _
AllowsMultipleConnections:=True)> _
Public Function GetConnectionInterface() As IWebPartTable
Return New TableProviderWebPart()
End Function
End Class
' The connection point for the provider control.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class TableProviderConnectionPoint
Inherits ProviderConnectionPoint
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, TableProviderWebPart).ConnectionPointEnabled
End Function
End Class
' This code sample creates a Web Parts control that acts as a consumer
' of information provided by the TableProvider.ascx control.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class TableConsumer
Inherits WebPart
Private _provider As IWebPartTable
Private _tableData As ICollection
Private Sub GetTableData(ByVal tableData As ICollection)
_tableData = CType(tableData, ICollection)
End Sub
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
If Not (_provider Is Nothing) Then
_provider.GetTableData(New TableCallback(AddressOf GetTableData))
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))
Next o
writer.WriteBreak()
writer.WriteLine()
count = count + 1
Next prop
Else
writer.Write("No data")
End If
Else
writer.Write("Not connected")
End If
End Sub
<ConnectionConsumer("Table")> _
Public Sub SetConnectionInterface(ByVal provider As IWebPartTable)
_provider = provider
End Sub
End Class
' The connection point for the consumer control.
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class TableConsumerConnectionPoint
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
End Class
End Namespace ' Samples.AspNet.CS.Controls
Druhou částí příkladu kódu je webová stránka, která deklaruje statické připojení a hostuje ovládací prvky. V horní části stránky je direktiva Register , která deklaruje obor názvů zdrojového kódu obsaženého v adresáři App_Code. Připojení je deklarováno pomocí elementu <asp:webpartconnection> . Ovládací prvky vlastního příjemce a zprostředkovatele jsou deklarovány v elementu <zonetemplate><asp:webpartzone> , který se vyžaduje, aby se mohli připojit (musí se nacházet v zóně, která dědí z WebPartZoneBase třídy).
<%@ 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>
Načtěte stránku v prohlížeči. Ovládací prvek příjemce zobrazí data poskytnutá ze zadané tabulky, která zprostředkovatel zpřístupní prostřednictvím instance IWebPartTable rozhraní.
Poznámky
Toto rozhraní je navržené pro použití s připojením webových částí. V připojení webových částí dva ovládací prvky serveru umístěné v WebPartZoneBase zóně navazují připojení a sdílejí data, přičemž jeden ovládací prvek funguje jako příjemce a druhý jako zprostředkovatel. Mechanismus pro sdílení dat v připojení webových částí je instance rozhraní, kterou poskytovatel slouží příjemci metodou zpětného volání. Aby bylo možné navázat připojení, musí příjemce i poskytovatel pracovat se stejným typem rozhraní pro sdílení dat. Pokud příjemce nerozpozná typ rozhraní odeslaný poskytovatelem, je stále možné připojit ovládací prvky pomocí transformátoru (objektu WebPartTransformer ), který přeloží instanci rozhraní odeslanou poskytovatelem na typ, který příjemce rozpozná. Podrobnosti o připojeních najdete v tématu WebPartConnection a Přehled připojení webových částí.
Rozhraní IWebPartTable je rozhraní zprostředkovatele, které je součástí ovládacího prvku webové části nastavené jako standardní rozhraní pro vytváření připojení založených na tabulce dat. Můžete také vytvořit vlastní rozhraní pro připojení webových částí, ale v mnoha webových aplikacích řízených daty je užitečné vytvářet připojení na základě společného pole (podrobnosti najdete IWebPartField v rozhraní), řádku (podrobnosti najdete v rozhraní IWebPartRow ) nebo tabulky ze zdroje dat. V typickém připojení by ovládací prvek fungující WebPart jako zprostředkovatel implementoval IWebPartTable rozhraní a poskytl instanci rozhraní příjemcům ve speciální metodě zpětného volání. Zprostředkovatel může například implementovat IWebPartTable rozhraní pro tabulku, která obsahuje data o finanční výkonnosti. Jiný WebPart ovládací prvek, který funguje jako příjemce, by definoval speciální metodu pro příjem instance rozhraní a pak by mohl extrahovat data a vykreslit graf pro zobrazení výsledných informací.
Rozhraní IWebPartTable má dva vystavené členy. Vlastnost Schema vrátí informace schématu o tabulce dat zapouzdřené v objektu PropertyDescriptorCollection . Metoda GetTableData deklaruje metodu, kterou implementátor (například ovládací prvek zprostředkovatele) používá k načtení dat tabulky instance rozhraní při vyvolání metody zpětného volání.
Vlastnosti
| Schema |
Získá informace o schématu pro tabulku dat, která se používá ke sdílení dat mezi dvěma WebPart ovládacími prvky. |
Metody
| GetTableData(TableCallback) |
Vrátí data pro tabulku, kterou rozhraní používá jako základ propojení mezi dvěma WebPart ovládacími prvky. |
Platí pro
Viz také
Váš názor
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu: https://aka.ms/ContentUserFeedback.
Odeslat a zobrazit názory pro