IWebPartField Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Definiert eine Anbieterschnittstelle für das Verbinden von zwei Serversteuerelementen mit einem einzelnen Datenfeld.
public interface class IWebPartFieldpublic interface IWebPartFieldtype IWebPartField = interfacePublic Interface IWebPartField- Abgeleitet
Beispiele
Im folgenden Codebeispiel wird veranschaulicht, wie Sie mithilfe der Schnittstelle eine statische Verbindung zwischen zwei Steuerelementen IWebPartField erstellen. Das Codebeispiel umfasst drei Teile:
Quellcode für zwei benutzerdefinierte WebPart Steuerelemente, die über die IWebPartField -Schnittstelle eine Verbindung herstellen können, wobei ein Steuerelement als Anbieter und das andere als Consumer fungiert.
Eine Webseite, die die Steuerelemente hostet und die statische Verbindung im Persistenzformat deklariert.
Eine Beschreibung, was geschieht, wenn der Beispielcode ausgeführt wird.
Der erste Teil des Codebeispiels ist der Quellcode für die beiden benutzerdefinierten Steuerelemente. Zunächst ist der Code für den Anbieter, der die IWebPartField Schnittstelle implementiert. Der Einfachheit halber erstellt der Anbieter im Beispiel eine Tabelle mit einigen Daten, anstatt eine Verbindung mit einer Datenbank herzustellen. Die GetConnectionInterface -Methode dient als Verbindungspunkt des Anbieters, die Rückrufmethode, die die Schnittstelleninstanz an den Consumer zurückgibt. Für den Consumer ruft er die Schnittstelleninstanz vom Anbieter in seiner Methode mit dem Namen SetConnectionInterfaceab, die mit einem ConnectionConsumer Attribut gekennzeichnet ist. Nach dem Abrufen der Instanz der Schnittstelle ruft der Consumer in seiner OnPreRender -Methode die Implementierung der GetFieldValue Methode im Anbieter auf, um die tatsächlichen Daten abzurufen.
Damit das Codebeispiel ausgeführt werden kann, müssen Sie diesen Quellcode kompilieren. Sie können sie explizit kompilieren und die resultierende Assembly im Ordner Bin ihrer Website oder im globalen Assemblycache ablegen. Alternativ können Sie den Quellcode im App_Code Ordner Ihrer Website ablegen, wo er zur Laufzeit dynamisch kompiliert wird. In diesem Codebeispiel wird die dynamische Kompilierung verwendet. Eine exemplarische Vorgehensweise zum Kompilieren finden Sie unter Exemplarische Vorgehensweise: Entwickeln und Verwenden eines benutzerdefinierten Webserversteuerelements.
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
Der zweite Teil des Codebeispiels ist die Webseite, die die statische Verbindung deklariert und die Steuerelemente hostet. Oben auf der Seite befindet sich eine Register Direktive, die den Namespace des Quellcodes deklariert, der im Verzeichnis App_Code enthalten ist. Die Verbindung wird mithilfe eines <asp:webpartconnection> -Elements deklariert. Die benutzerdefinierten Consumer- und Anbietersteuerelemente werden in einem <zonetemplate> Element innerhalb eines <asp:webpartzone> Elements deklariert, das erforderlich ist, damit sie eine Verbindung herstellen können (sie müssen sich in einer Zone befinden, die von der WebPartZoneBase -Klasse erbt).
<%@ 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>
Laden Sie die Seite in einen Browser. Das Consumersteuerelement zeigt die aus dem angegebenen Feld bereitgestellten Daten an, die der Anbieter über eine Instanz der IWebPartField Schnittstelle verfügbar macht.
Hinweise
Diese Schnittstelle ist für die Verwendung mit Webpartverbindungen konzipiert. In einer Webparts-Verbindung stellen zwei Serversteuerelemente, die sich in einer WebPartZoneBase Zone befinden, eine Verbindung her und geben Daten frei, wobei ein Steuerelement als Consumer und das andere Steuerelement als Anbieter fungiert. Der Mechanismus zum Freigeben von Daten in einer Webpartverbindung ist eine Schnittstelleninstanz, die der Anbieter dem Consumer mithilfe einer Rückrufmethode bedient. Zum Herstellen einer Verbindung müssen Consumer und Anbieter für die Gemeinsame Nutzung von Daten mit demselben Schnittstellentyp arbeiten. Wenn der Consumer den vom Anbieter gesendeten Schnittstellentyp nicht erkennt, ist es dennoch möglich, die Steuerelemente mithilfe eines Transformators (eines WebPartTransformer Objekts) zu verbinden, der die vom Anbieter gesendete Schnittstelleninstanz in einen Vom Consumer erkannten Typ übersetzt. Ausführliche Informationen zu Verbindungen finden Sie unter WebPartConnectionUnd Übersicht über Webpartsverbindungen.
Die IWebPartField Schnittstelle ist eine Anbieterschnittstelle, die im Webpart-Steuerelementsatz als Standardschnittstelle zum Erstellen von Verbindungen basierend auf einem Datenfeld enthalten ist. Sie können auch benutzerdefinierte Schnittstellen für die Verwendung mit Webparts-Verbindungen erstellen. In vielen datengesteuerten Webanwendungen ist es jedoch nützlich, Verbindungen basierend auf einer gemeinsamen Zeile (Details finden Sie in der IWebPartRow Schnittstelle), einer Tabelle (Details finden Sie in der IWebPartTable Schnittstelle) oder einem Feld aus der Datenquelle mithilfe der IWebPartField Schnittstelle. In einer typischen Verbindung implementiert ein WebPart Steuerelement, das als Anbieter fungiert, die IWebPartField Schnittstelle und stellt eine Instanz der Schnittstelle für Consumer in einer speziellen Rückrufmethode bereit. Beispielsweise kann der Anbieter eine IWebPartField Schnittstelle für ein Feld in Ihrer Benutzerinformationstabelle implementieren, das die Postleitzahldaten eines Webbenutzers enthält. Ein anderes WebPart Steuerelement, das als Verbraucher fungiert, würde eine spezielle Methode definieren, um die Schnittstelleninstanz zu empfangen, und könnte dann die Postleitzahldaten extrahieren und Wetterinformationen basierend auf der Postleitzahl suchen und anzeigen.
Die IWebPartField Schnittstelle verfügt über zwei verfügbar gemachte Member. Die Schema -Eigenschaft gibt Schemainformationen zu dem in einem PropertyDescriptor -Objekt gekapselten Datenfeld zurück. Die GetFieldValue -Methode deklariert eine Methode, die ein Implementierer (z. B. ein Anbietersteuerelement) verwendet, um die Felddaten der Schnittstelleninstanz abzurufen, wenn die Rückrufmethode aufgerufen wird.
Eigenschaften
| Schema |
Ruft die Schemainformationen für ein Datenfeld ab, mit dessen Hilfe von zwei WebPart-Steuerelementen Daten gemeinsam verwendet werden können. |
Methoden
| GetFieldValue(FieldCallback) |
Gibt den Wert für das Feld zurück, das von der Schnittstelle als Basis einer Verbindung zwischen zwei WebPart-Steuerelementen verwendet wird. |
Gilt für:
Weitere Informationen
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für