IWebPartField Antarmuka
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Menentukan antarmuka penyedia untuk menyambungkan dua kontrol server menggunakan satu bidang data.
public interface class IWebPartFieldpublic interface IWebPartFieldtype IWebPartField = interfacePublic Interface IWebPartField- Turunan
Contoh
Contoh kode berikut menunjukkan cara membuat koneksi statis antara dua kontrol menggunakan IWebPartField antarmuka . Contoh kode memiliki tiga bagian:
Kode sumber untuk dua kontrol kustom WebPart yang dapat membentuk koneksi menggunakan IWebPartField antarmuka, dengan satu kontrol bertindak sebagai penyedia, yang lain bertindak sebagai konsumen.
Halaman Web yang menghosting kontrol dan mendeklarasikan koneksi statis dalam format persistensi.
Deskripsi tentang apa yang terjadi ketika kode contoh berjalan.
Bagian pertama dari contoh kode adalah kode sumber untuk dua kontrol kustom. Pertama adalah kode untuk penyedia, yang mengimplementasikan IWebPartField antarmuka. Untuk kesederhanaan dalam contoh, penyedia membuat tabel dengan beberapa data daripada menyambungkan ke database. Metode ini GetConnectionInterface berfungsi sebagai titik koneksi penyedia, metode panggilan balik yang mengembalikan instans antarmuka kepada konsumen. Adapun konsumen, ia mengambil instans antarmuka dari penyedia dalam metode SetConnectionInterfacebernama , yang ditandai dengan ConnectionConsumer atribut . Setelah mengambil instans antarmuka, konsumen, dalam metodenya OnPreRender , memanggil implementasi GetFieldValue metode di penyedia, untuk mengambil data aktual.
Agar contoh kode berjalan, Anda harus mengkompilasi kode sumber ini. Anda dapat mengkompilasinya secara eksplisit dan meletakkan rakitan yang dihasilkan di folder Bin situs Web Anda atau cache perakitan global. Atau, Anda dapat meletakkan kode sumber di folder App_Code situs Anda, di mana kode tersebut akan dikompilasi secara dinamis pada durasi. Contoh kode ini menggunakan kompilasi dinamis. Untuk panduan yang menunjukkan cara mengkompilasi, lihat Panduan: Mengembangkan dan Menggunakan Kontrol Server Web Kustom.
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
Bagian kedua dari contoh kode adalah halaman Web yang mendeklarasikan koneksi statis dan menghosting kontrol. Di dekat bagian atas halaman adalah Register direktif yang mendeklarasikan namespace kode sumber yang terkandung dalam direktori App_Code. Koneksi dinyatakan menggunakan <asp:webpartconnection> elemen . Kontrol konsumen dan penyedia kustom dideklarasikan dalam elemen <asp:webpartzone> dalam <zonetemplate> elemen , yang diperlukan agar mereka dapat terhubung (mereka harus berada di dalam zona yang mewarisi dari WebPartZoneBase kelas).
<%@ 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>
Muat halaman di browser. Kontrol konsumen menampilkan data yang disediakan dari bidang yang ditentukan, yang disediakan penyedia melalui instans IWebPartField antarmuka.
Keterangan
Antarmuka ini dirancang untuk digunakan dengan koneksi Bagian Web. Dalam koneksi Bagian Web, dua kontrol server yang berada di WebPartZoneBase zona membuat koneksi dan berbagi data, dengan satu kontrol bertindak sebagai konsumen dan kontrol lainnya yang bertindak sebagai penyedia. Mekanisme untuk berbagi data dalam koneksi Bagian Web adalah instans antarmuka, yang dilayani penyedia kepada konsumen dengan metode panggilan balik. Untuk membuat koneksi, konsumen dan penyedia harus bekerja dengan jenis antarmuka yang sama untuk berbagi data. Jika konsumen tidak mengenali jenis antarmuka yang dikirim oleh penyedia, masih mungkin untuk menghubungkan kontrol melalui transformator ( WebPartTransformer objek) yang menerjemahkan instans antarmuka yang dikirim oleh penyedia ke dalam jenis yang dikenali konsumen. Untuk detail tentang koneksi, lihat WebPartConnection dan Gambaran Umum Koneksi Bagian Web.
Antarmuka IWebPartField adalah antarmuka penyedia yang disertakan dengan kontrol Komponen Web yang ditetapkan sebagai antarmuka standar untuk membuat koneksi berdasarkan bidang data. Anda juga dapat membuat antarmuka kustom untuk digunakan dengan koneksi Bagian Web, tetapi di banyak aplikasi Web berbasis data, berguna untuk membuat koneksi berdasarkan baris umum (untuk detailnya, lihat IWebPartRow antarmuka), tabel (untuk detailnya, lihat IWebPartTable antarmuka), atau bidang dari sumber data, menggunakan IWebPartField antarmuka. Dalam koneksi umum, kontrol yang WebPart bertindak sebagai penyedia akan mengimplementasikan IWebPartField antarmuka dan menyediakan instans antarmuka kepada konsumen dalam metode panggilan balik khusus. Misalnya, penyedia mungkin mengimplementasikan IWebPartField antarmuka untuk bidang dalam tabel informasi pengguna Anda yang berisi data kode pos pengguna Web. Kontrol lain WebPart yang bertindak sebagai konsumen akan menentukan metode khusus untuk menerima instans antarmuka, dan kemudian dapat mengekstrak data kode pos, dan mencari dan menampilkan informasi cuaca berdasarkan kode pos.
Antarmuka IWebPartField memiliki dua anggota yang diekspos. Properti Schema mengembalikan informasi skema tentang bidang data yang dienkapsulasi dalam PropertyDescriptor objek. Metode ini GetFieldValue menyatakan metode yang digunakan pelaksana (seperti kontrol penyedia) untuk mengambil data bidang instans antarmuka saat metode panggilan balik dipanggil.
Properti
| Schema |
Mendapatkan informasi skema untuk bidang data yang digunakan untuk berbagi data di antara dua WebPart kontrol. |
Metode
| GetFieldValue(FieldCallback) |
Mengembalikan nilai bidang yang sedang digunakan oleh antarmuka sebagai dasar koneksi antara dua WebPart kontrol. |
