ProviderConnectionPoint Klasse
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 einen Verbindungspunktobjekt, mit dem ein Serversteuerelement beim Verbinden mit einem Consumer als Anbieter fungieren kann.
public ref class ProviderConnectionPoint : System::Web::UI::WebControls::WebParts::ConnectionPoint
public class ProviderConnectionPoint : System.Web.UI.WebControls.WebParts.ConnectionPoint
type ProviderConnectionPoint = class
inherit ConnectionPoint
Public Class ProviderConnectionPoint
Inherits ConnectionPoint
- Vererbung
Beispiele
Das folgende Codebeispiel zeigt einfache Möglichkeiten, um eine Verbindung deklarativ, programmgesteuert oder über die Benutzeroberfläche zu erstellen, wobei jeweils ein Anbieterverbindungspunkt verwendet wird.
Das Beispiel umfasst vier Teile:
Ein Benutzersteuerelement, mit dem Sie den Anzeigemodus für Webparts auf einer Seite ändern können.
Quellcode für eine Schnittstelle und zwei WebPart Steuerelemente, die als Anbieter und Consumer für eine Verbindung fungieren.
Eine Webseite, die alle Steuerelemente hosten und das Codebeispiel ausführen soll.
Eine Erklärung zum Ausführen der Beispielseite.
Der erste Teil dieses Codebeispiels ist das Benutzersteuerelement, mit dem Benutzer die Anzeigemodi auf einer Webseite ändern können. Speichern Sie den folgenden Quellcode in einer ASCX-Datei, und geben Sie ihr den Dateinamen an, der dem Src
Attribut der Register
-Direktive für dieses Benutzersteuerelement zugewiesen ist, das sich am Anfang der Hostingwebseite befindet. Ausführliche Informationen zu Anzeigemodi und eine Beschreibung des Quellcodes in diesem Steuerelement finden Sie unter Exemplarische Vorgehensweise: Ändern von Anzeigemodi auf einer Webparts-Seite.
<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
// Use a field to reference the current WebPartManager.
WebPartManager _manager;
void Page_Init(object sender, EventArgs e)
{
Page.InitComplete += new EventHandler(InitComplete);
}
void InitComplete(object sender, System.EventArgs e)
{
_manager = WebPartManager.GetCurrentWebPartManager(Page);
String browseModeName = WebPartManager.BrowseDisplayMode.Name;
// Fill the dropdown with the names of supported display modes.
foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
{
String modeName = mode.Name;
// Make sure a mode is enabled before adding it.
if (mode.IsEnabled(_manager))
{
ListItem item = new ListItem(modeName, modeName);
DisplayModeDropdown.Items.Add(item);
}
}
// If shared scope is allowed for this user, display the scope-switching
// UI and select the appropriate radio button for the current user scope.
if (_manager.Personalization.CanEnterSharedScope)
{
Panel2.Visible = true;
if (_manager.Personalization.Scope == PersonalizationScope.User)
RadioButton1.Checked = true;
else
RadioButton2.Checked = true;
}
}
// Change the page to the selected display mode.
void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)
{
String selectedMode = DisplayModeDropdown.SelectedValue;
WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
if (mode != null)
_manager.DisplayMode = mode;
}
// Set the selected item equal to the current display mode.
void Page_PreRender(object sender, EventArgs e)
{
ListItemCollection items = DisplayModeDropdown.Items;
int selectedIndex =
items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
DisplayModeDropdown.SelectedIndex = selectedIndex;
}
// Reset all of a user's personalization data for the page.
protected void LinkButton1_Click(object sender, EventArgs e)
{
_manager.Personalization.ResetPersonalizationState();
}
// If not in User personalization scope, toggle into it.
protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
{
if (_manager.Personalization.Scope == PersonalizationScope.Shared)
_manager.Personalization.ToggleScope();
}
// If not in Shared scope, and if user is allowed, toggle the scope.
protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
{
if (_manager.Personalization.CanEnterSharedScope &&
_manager.Personalization.Scope == PersonalizationScope.User)
_manager.Personalization.ToggleScope();
}
</script>
<div>
<asp:Panel ID="Panel1" runat="server"
Borderwidth="1"
Width="230"
BackColor="lightgray"
Font-Names="Verdana, Arial, Sans Serif" >
<asp:Label ID="Label1" runat="server"
Text=" Display Mode"
Font-Bold="true"
Font-Size="8"
Width="120"
AssociatedControlID="DisplayModeDropdown"/>
<asp:DropDownList ID="DisplayModeDropdown" runat="server"
AutoPostBack="true"
Width="120"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
<asp:LinkButton ID="LinkButton1" runat="server"
Text="Reset User State"
ToolTip="Reset the current user's personalization data for the page."
Font-Size="8"
OnClick="LinkButton1_Click" />
<asp:Panel ID="Panel2" runat="server"
GroupingText="Personalization Scope"
Font-Bold="true"
Font-Size="8"
Visible="false" >
<asp:RadioButton ID="RadioButton1" runat="server"
Text="User"
AutoPostBack="true"
GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
<asp:RadioButton ID="RadioButton2" runat="server"
Text="Shared"
AutoPostBack="true"
GroupName="Scope"
OnCheckedChanged="RadioButton2_CheckedChanged" />
</asp:Panel>
</asp:Panel>
</div>
<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
' Use a field to reference the current WebPartManager.
Dim _manager As WebPartManager
Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
AddHandler Page.InitComplete, AddressOf InitComplete
End Sub
Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
_manager = WebPartManager.GetCurrentWebPartManager(Page)
Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
' Fill the dropdown with the names of supported display modes.
Dim mode As WebPartDisplayMode
For Each mode In _manager.SupportedDisplayModes
Dim modeName As String = mode.Name
' Make sure a mode is enabled before adding it.
If mode.IsEnabled(_manager) Then
Dim item As New ListItem(modeName, modeName)
DisplayModeDropdown.Items.Add(item)
End If
Next mode
' If shared scope is allowed for this user, display the scope-switching
' UI and select the appropriate radio button for the current user scope.
If _manager.Personalization.CanEnterSharedScope Then
Panel2.Visible = True
If _manager.Personalization.Scope = PersonalizationScope.User Then
RadioButton1.Checked = True
Else
RadioButton2.Checked = True
End If
End If
End Sub
' Change the page to the selected display mode.
Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _
ByVal e As EventArgs)
Dim selectedMode As String = DisplayModeDropdown.SelectedValue
Dim mode As WebPartDisplayMode = _
_manager.SupportedDisplayModes(selectedMode)
If Not (mode Is Nothing) Then
_manager.DisplayMode = mode
End If
End Sub
' Set the selected item equal to the current display mode.
Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
Dim items As ListItemCollection = DisplayModeDropdown.Items
Dim selectedIndex As Integer = _
items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
DisplayModeDropdown.SelectedIndex = selectedIndex
End Sub
' Reset all of a user's personalization data for the page.
Protected Sub LinkButton1_Click(ByVal sender As Object, _
ByVal e As EventArgs)
_manager.Personalization.ResetPersonalizationState()
End Sub
' If not in User personalization scope, toggle into it.
Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
ByVal e As EventArgs)
If _manager.Personalization.Scope = PersonalizationScope.Shared Then
_manager.Personalization.ToggleScope()
End If
End Sub
' If not in Shared scope, and if user is allowed, toggle the scope.
Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
ByVal e As EventArgs)
If _manager.Personalization.CanEnterSharedScope AndAlso _
_manager.Personalization.Scope = PersonalizationScope.User Then
_manager.Personalization.ToggleScope()
End If
End Sub
</script>
<div>
<asp:Panel ID="Panel1" runat="server"
Borderwidth="1"
Width="230"
BackColor="lightgray"
Font-Names="Verdana, Arial, Sans Serif" >
<asp:Label ID="Label1" runat="server"
Text=" Display Mode"
Font-Bold="true"
Font-Size="8"
Width="120"
AssociatedControlID="DisplayModeDropdown"/>
<asp:DropDownList ID="DisplayModeDropdown" runat="server"
AutoPostBack="true"
Width="120"
OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
<asp:LinkButton ID="LinkButton1" runat="server"
Text="Reset User State"
ToolTip="Reset the current user's personalization data for the page."
Font-Size="8"
OnClick="LinkButton1_Click" />
<asp:Panel ID="Panel2" runat="server"
GroupingText="Personalization Scope"
Font-Bold="true"
Font-Size="8"
Visible="false" >
<asp:RadioButton ID="RadioButton1" runat="server"
Text="User"
AutoPostBack="true"
GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
<asp:RadioButton ID="RadioButton2" runat="server"
Text="Shared"
AutoPostBack="true"
GroupName="Scope"
OnCheckedChanged="RadioButton2_CheckedChanged" />
</asp:Panel>
</asp:Panel>
</div>
Der zweite Teil des Codebeispiels ist der Quellcode für die Schnittstelle und steuerelemente. Die Quelldatei enthält eine einfache Schnittstelle namens IZipCode
. Es gibt auch eine WebPart Klasse namens ZipCodeWebPart
, die die -Schnittstelle implementiert und als Anbietersteuerelement fungiert. Die - ProvideIZipCode
Methode ist die Rückrufmethode, die den einzigen Member der Schnittstelle implementiert. Die -Methode gibt einfach eine Instanz der -Schnittstelle zurück. Beachten Sie, dass die -Methode mit einem ConnectionProvider
-Attribut in ihren Metadaten gekennzeichnet ist. Dies ist der Mechanismus zum Identifizieren der Methode als Rückrufmethode für den Verbindungspunkt des Anbieters. Die andere WebPart Klasse heißt WeatherWebPart
, und sie fungiert als Consumer für die Verbindung. Diese Klasse verfügt über eine Methode namens GetZipCode
, die eine Instanz der IZipCode
-Schnittstelle vom Anbietersteuerelement abruft. Beachten Sie, dass diese Methode als Verbindungspunktmethode des Consumers mit einem ConnectionConsumer
-Attribut in den Metadaten gekennzeichnet ist. Dies ist der Mechanismus zum Identifizieren der Verbindungspunktmethode im Consumersteuerelement.
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 Ordner App_Code Ihrer Website ablegen, wo er zur Laufzeit dynamisch kompiliert wird. In diesem Codebeispiel wird die dynamische Kompilierung verwendet. Eine exemplarische Vorgehensweise, die das Kompilieren veranschaulicht, finden Sie unter Exemplarische Vorgehensweise: Entwickeln und Verwenden eines benutzerdefinierten Webserversteuerelements.
namespace Samples.AspNet.CS.Controls
{
using System;
using System.Web;
using System.Web.Security;
using System.Security.Permissions;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public interface IZipCode
{
string ZipCode { get; set;}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class ZipCodeWebPart : WebPart, IZipCode
{
string zipCodeText = String.Empty;
TextBox input;
Button send;
public ZipCodeWebPart()
{
}
// Make the implemented property personalizable to save
// the Zip Code between browser sessions.
[Personalizable()]
public virtual string ZipCode
{
get { return zipCodeText; }
set { zipCodeText = value; }
}
// This is the callback method that returns the provider.
[ConnectionProvider("Zip Code Provider", "ZipCodeProvider")]
public IZipCode ProvideIZipCode()
{
return this;
}
protected override void CreateChildControls()
{
Controls.Clear();
input = new TextBox();
this.Controls.Add(input);
send = new Button();
send.Text = "Enter 5-digit Zip Code";
send.Click += new EventHandler(this.submit_Click);
this.Controls.Add(send);
}
private void submit_Click(object sender, EventArgs e)
{
if (!string.IsNullOrEmpty(input.Text))
{
zipCodeText = Page.Server.HtmlEncode(input.Text);
input.Text = String.Empty;
}
}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class WeatherWebPart : WebPart
{
private IZipCode _provider;
string _zipSearch;
Label DisplayContent;
// This method is identified by the ConnectionConsumer
// attribute, and is the mechanism for connecting with
// the provider.
[ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")]
public void GetIZipCode(IZipCode Provider)
{
_provider = Provider;
}
protected override void OnPreRender(EventArgs e)
{
EnsureChildControls();
if (this._provider != null)
{
_zipSearch = _provider.ZipCode.Trim();
DisplayContent.Text = "My Zip Code is: " + _zipSearch;
}
}
protected override void CreateChildControls()
{
Controls.Clear();
DisplayContent = new Label();
this.Controls.Add(DisplayContent);
}
}
}
Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Interface IZipCode
Property ZipCode() As String
End Interface
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class ZipCodeWebPart
Inherits WebPart
Implements IZipCode
Private zipCodeText As String = String.Empty
Private input As TextBox
Private send As Button
Public Sub New()
End Sub
' Make the implemented property personalizable to save
' the Zip Code between browser sessions.
<Personalizable()> _
Public Property ZipCode() As String _
Implements IZipCode.ZipCode
Get
Return zipCodeText
End Get
Set(ByVal value As String)
zipCodeText = value
End Set
End Property
' This is the callback method that returns the provider.
<ConnectionProvider("Zip Code Provider", "ZipCodeProvider")> _
Public Function ProvideIZipCode() As IZipCode
Return Me
End Function
Protected Overrides Sub CreateChildControls()
Controls.Clear()
input = New TextBox()
Me.Controls.Add(input)
send = New Button()
send.Text = "Enter 5-digit Zip Code"
AddHandler send.Click, AddressOf Me.submit_Click
Me.Controls.Add(send)
End Sub
Private Sub submit_Click(ByVal sender As Object, _
ByVal e As EventArgs)
If input.Text <> String.Empty Then
zipCodeText = Page.Server.HtmlEncode(input.Text)
input.Text = String.Empty
End If
End Sub
End Class
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class WeatherWebPart
Inherits WebPart
Private _provider As IZipCode
Private _zipSearch As String
Private DisplayContent As Label
' This method is identified by the ConnectionConsumer
' attribute, and is the mechanism for connecting with
' the provider.
<ConnectionConsumer("Zip Code Consumer", "ZipCodeConsumer")> _
Public Sub GetIZipCode(ByVal Provider As IZipCode)
_provider = Provider
End Sub
Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
EnsureChildControls()
If Not (Me._provider Is Nothing) Then
_zipSearch = _provider.ZipCode.Trim()
DisplayContent.Text = "My Zip Code is: " + _zipSearch
End If
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
DisplayContent = New Label()
Me.Controls.Add(DisplayContent)
End Sub
End Class
End Namespace
Der dritte Teil des Codebeispiels ist die Webseite. Ganz oben befinden Register
sich Anweisungen zum Registrieren der benutzerdefinierten Steuerelemente, die die Verbindung bilden, und das Benutzersteuerelement, mit dem Benutzer die Anzeigemodi auf der Seite ändern können. Die Verbindung selbst wird deklarativ innerhalb des <staticconnections>
Elements auf der Seite erstellt. Dies veranschaulicht eine Möglichkeit zum Erstellen einer Verbindung– beachten Sie das ProviderConnectionPointID
-Attribut im <asp:webpartconnection>
-Element. Sie können die Verbindung auch programmgesteuert erstellen. der Code für die Vorgehensweise befindet sich in der Button1_Click
-Methode. In diesem Fall wird ein ProviderConnectionPoint -Objekt erstellt und dann an eine Methode übergeben, die die eigentliche Verbindung erstellt. Unabhängig davon, ob die Verbindung deklarativ oder programmgesteuert erstellt wird, müssen Verbindungspunkte immer sowohl für den Anbieter als auch für den Consumer angegeben werden. Die Button2_Click
-Methode greift sowohl für den ConnectionPoint Anbieter als auch für den Consumer auf die Objekte zu und schreibt einige ihrer Eigenschaftswerte in eine Bezeichnung auf der Seite.
<%@ Page Language="C#" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuCS"
src="~/displaymodemenucs.ascx" %>
<%@ Register TagPrefix="aspSample"
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">
<script runat="server">
protected void Button1_Click(object sender, EventArgs e)
{
ProviderConnectionPoint provPoint =
mgr.GetProviderConnectionPoints(zip1)["ZipCodeProvider"];
ConsumerConnectionPoint connPoint =
mgr.GetConsumerConnectionPoints(weather1)["ZipCodeConsumer"];
if(mgr.CanConnectWebParts(zip1, provPoint, weather1, connPoint))
mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint);
}
protected void Button2_Click(object sender, EventArgs e)
{
WebPartConnection conn = mgr.Connections[0];
lblConn.Text = "<h2>Connection Point Details</h2>" +
"<h3>Provider Connection Point</h3>" +
" Display name: " + conn.ProviderConnectionPoint.DisplayName +
"<br />" +
" ID: " + conn.ProviderConnectionPoint.ID +
"<br />" +
" Interface type: " +
conn.ProviderConnectionPoint.InterfaceType.ToString() +
"<br />" +
" Control type: " + conn.ProviderConnectionPoint.ControlType.ToString() +
"<br />" +
" Allows multiple connections: " +
conn.ProviderConnectionPoint.AllowsMultipleConnections.ToString() +
"<br />" +
" Enabled: " + conn.ProviderConnectionPoint.GetEnabled(zip1).ToString() +
"<hr />" +
"<h3>Consumer Connection Point</h3>" +
" Display name: " + conn.ConsumerConnectionPoint.DisplayName +
"<br />" +
" ID: " + conn.ConsumerConnectionPoint.ID +
"<br />" +
" Interface type: " + conn.ConsumerConnectionPoint.InterfaceType.ToString() +
"<br />" +
" Control type: " + conn.ConsumerConnectionPoint.ControlType.ToString() +
"<br />" +
" Allows multiple connections: " +
conn.ConsumerConnectionPoint.AllowsMultipleConnections.ToString() +
"<br />" +
" Enabled: " + conn.ConsumerConnectionPoint.GetEnabled(zip1).ToString();
}
protected void Page_Load(object sender, EventArgs e)
{
lblConn.Text = String.Empty;
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr" runat="server" >
<StaticConnections>
<asp:WebPartConnection ID="conn1"
ConsumerConnectionPointID="ZipCodeConsumer"
ConsumerID="weather1"
ProviderConnectionPointID="ZipCodeProvider"
ProviderID="zip1" />
</StaticConnections>
</asp:WebPartManager>
<uc1:displaymodemenucs id="menu1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
</asp:ConnectionsZone>
<asp:Button ID="Button1" runat="server"
Text="Dynamic Connection"
OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server"
Text="Connection Point Details"
OnClick="Button2_Click" />
<br />
<asp:Label ID="lblConn" runat="server" />
</div>
</form>
</body>
</html>
<%@ Page Language="VB" %>
<%@ register tagprefix="uc1"
tagname="DisplayModeMenuVB"
src="~/displaymodemenuvb.ascx" %>
<%@ Register TagPrefix="aspSample"
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">
<script runat="server">
Protected Sub Button1_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Dim provPoint As ProviderConnectionPoint = _
mgr.GetProviderConnectionPoints(zip1)("ZipCodeProvider")
Dim connPoint As ConsumerConnectionPoint = _
mgr.GetConsumerConnectionPoints(weather1)("ZipCodeConsumer")
If mgr.CanConnectWebParts(zip1, provPoint, weather1, connPoint) Then
mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint)
End If
End Sub
Protected Sub Button2_Click(ByVal sender As Object, _
ByVal e As System.EventArgs)
Dim conn As WebPartConnection = mgr.Connections(0)
lblConn.Text = "<h2>Connection Point Details</h2>" & _
"<h3>Provider Connection Point</h3>" & _
" Display name: " & conn.ProviderConnectionPoint.DisplayName & _
"<br />" & _
" ID: " & conn.ProviderConnectionPoint.ID & _
"<br />" & _
" Interface type: " & conn.ProviderConnectionPoint.InterfaceType.ToString() & _
"<br />" & _
" Control type: " & conn.ProviderConnectionPoint.ControlType.ToString() & _
"<br />" & _
" Allows multiple connections: " & _
conn.ProviderConnectionPoint.AllowsMultipleConnections.ToString() & _
"<br />" & _
" Enabled: " & conn.ProviderConnectionPoint.GetEnabled(zip1).ToString() & _
"<hr />" & _
"<h3>Consumer Connection Point</h3>" & _
" Display name: " & conn.ConsumerConnectionPoint.DisplayName & _
"<br />" & _
" ID: " & conn.ConsumerConnectionPoint.ID & _
"<br />" & _
" Interface type: " & conn.ConsumerConnectionPoint.InterfaceType.ToString() & _
"<br />" & _
" Control type: " & conn.ConsumerConnectionPoint.ControlType.ToString() & _
"<br />" & _
" Allows multiple connections: " & _
conn.ConsumerConnectionPoint.AllowsMultipleConnections.ToString() & _
"<br />" & _
" Enabled: " & conn.ConsumerConnectionPoint.GetEnabled(zip1).ToString()
End Sub
Protected Sub Page_Load(ByVal sender As Object, _
ByVal e As System.EventArgs)
lblConn.Text = String.Empty
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Untitled Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:WebPartManager ID="mgr" runat="server" >
<StaticConnections>
<asp:WebPartConnection ID="conn1"
ConsumerConnectionPointID="ZipCodeConsumer"
ConsumerID="weather1"
ProviderConnectionPointID="ZipCodeProvider"
ProviderID="zip1" />
</StaticConnections>
</asp:WebPartManager>
<uc1:displaymodemenuvb id="menu1" runat="server" />
<asp:WebPartZone ID="WebPartZone1" runat="server">
<ZoneTemplate>
<aspSample:ZipCodeWebPart ID="zip1" runat="server"
Title="Zip Code Provider" />
<aspSample:WeatherWebPart ID="weather1" runat="server"
Title="Zip Code Consumer" />
</ZoneTemplate>
</asp:WebPartZone>
<asp:ConnectionsZone ID="ConnectionsZone1" runat="server">
</asp:ConnectionsZone>
<asp:Button ID="Button1" runat="server"
Text="Dynamic Connection"
OnClick="Button1_Click" />
<br />
<asp:Button ID="Button2" runat="server"
Text="Connection Point Details"
OnClick="Button2_Click" />
<br />
<asp:Label ID="lblConn" runat="server" />
</div>
</form>
</body>
</html>
Nachdem Sie die Seite in einem Browser geladen haben, klicken Sie auf die Schaltfläche Verbindungspunktdetails . Informationen zu den in der deklarativen Verbindung eingerichteten Anbieter- und Consumerverbindungspunkten werden angezeigt. Verwenden Sie als Nächstes das Dropdown-Steuerelement Anzeigemodus , um die Seite in den Verbindungsmodus zu wechseln. Klicken Sie im Menü Verben des Steuerelements "PostleitzahlverbraucherWebPart " (dargestellt durch einen Pfeil nach unten in der Titelleiste) auf das Verb verbinden. Die Verbindungsoberfläche wird angezeigt, die automatisch von dem auf der <asp:connectionszone>
Seite deklarierten Steuerelement erstellt wird. Dies ist eine weitere Möglichkeit, eine Verbindung (über die Benutzeroberfläche) zusammen mit den zuvor erläuterten deklarativen und programmgesteuerten Methoden zu erstellen. Klicken Sie auf die Schaltfläche Trennen , um die vorhandene statische Verbindung zu beenden. Klicken Sie auf den Link Verbindung mit einem Anbieter erstellen . Auf der Benutzeroberfläche wird nun ein Dropdownsteuerelement angezeigt, das den Anzeigenamen des Anbieterverbindungspunkts auflistet. Wählen Sie den Verbindungspunkt in der Dropdownliste aus, und klicken Sie dann auf Verbinden , um die Verbindung abzuschließen. Klicken Sie als Nächstes erneut auf Trennen . Klicken Sie dann auf die Schaltfläche Dynamische Verbindung , um eine Verbindung programmgesteuert zu erstellen. Verwenden Sie das Anzeigemodus-Steuerelement , um die Seite in den Browsermodus zurückzugeben. Klicken Sie erneut auf die Schaltfläche Verbindungspunktdetails , um erneut Details zum Anbieterverbindungspunktobjekt anzugeben.
Das Beispiel hat gezeigt, wie eine Verbindung hergestellt und ein Anbieterverbindungspunkt auf drei Arten verwendet wird: eine statische Verbindung, die im Webseitenmarkup deklariert ist; eine Verbindung, die im Code erstellt wurde, der ein ProviderConnectionPoint -Objekt verwendet hat, und eine verbindung, die von einem Benutzer über die Verbindungsbenutzeroberfläche erstellt wurde.
Hinweise
In jeder Webparts-Verbindung zwischen zwei Serversteuerelementen muss jedes Steuerelement (neben anderen Anforderungen) über ein zugeordnetes Verbindungspunktobjekt verfügen, das es ermöglicht, eine Verbindung mit dem anderen Steuerelement herzustellen und Daten bereitzustellen oder zu nutzen, je nachdem, ob das Steuerelement als Anbieter oder Consumer für die Verbindung festgelegt ist. Ein ConnectionPoint -Objekt enthält im Allgemeinen die Details dazu, wie ein Steuerelement eine Verbindung mit einem anderen Steuerelement herstellen kann, und den Typ der Daten, die es freigeben kann. Für ein Steuerelement, das als Anbieter in einer Verbindung fungiert, muss sein Verbindungspunkt ein ProviderConnectionPoint -Objekt sein. Ausführliche Informationen zu Webpartsverbindungen und -verbindungspunkten finden Sie in den Themen im Abschnitt Siehe auch weiter unten.
Um ein ProviderConnectionPoint Objekt zu erstellen, sind mehrere Schritte erforderlich:
Erstellen Sie eine Schnittstelle. Wenn ein Anbieter Daten für einen Consumer teilt, ruft er eine Instanz einer Schnittstelle ab und gibt diese Instanz an einen Consumer zurück.
Implementieren Sie die -Schnittstelle in einem Anbieter. Ein WebPart oder ein anderes Serversteuerelement (jeder Typ von Serversteuerelementen in einer WebPartZoneBase Zone kann verwendet werden), das der Anbieter ist, muss die im ersten Schritt erstellte Schnittstelle implementieren.
Identifizieren sie eine Rückrufmethode. Eine Methode im Anbieter muss als Rückrufmethode identifiziert werden, um eine Verbindung herzustellen. Diese Methode gibt eine Instanz der implementierten Schnittstelle an einen Consumer zurück. Der Webparts-Ansatz zum Identifizieren einer Rückrufmethode im Anbieter besteht darin, der Methode, die die Schnittstelleninstanz zurückgibt, ein
ConnectionProvider
Metadatenattribut (durch die ConnectionProviderAttribute -Klasse definiert) hinzuzufügen. Wenn das Attribut hinzugefügt wird, ist der einzige erforderliche Parameter ein Anzeigename, der für den Anbieterverbindungspunkt verwendet werden soll. Optionale Parameter können auch hinzugefügt werden, z. B. eine ID für den Verbindungspunkt.
Nachdem ein Steuerelement als Anbieter ausgestattet wurde, kann das Steuerelement an Verbindungen teilnehmen (vorausgesetzt, dass ein Consumersteuerelement ähnlich ausgestattet und verfügbar ist). Um eine statische, deklarative Verbindung im Markup einer Webseite zu erstellen, können Entwickler das <asp:webpartconnection>
-Element verwenden. Wenn das ConnectionProvider
Attribut im Anbieterquellcode, das die Rückrufmethode identifiziert, eine ID für den Verbindungspunkt angibt, muss dieser Wert dem ProviderConnectionPointID
Attribut im <asp:webpartconnection>
-Element auf einer Seite zugewiesen werden. Ein Grund dafür, dass ein Entwickler möglicherweise eine ID für einen Anbieterverbindungspunkt angibt, ist, wenn mehrere Verbindungspunkte im Anbietersteuerelement vorhanden sind. Wenn für den Anbieterverbindungspunkt im Anbietersteuerelement keine ID angegeben ist, muss dem Attribut auf der ProviderConnectionPointID
Seite auch kein Wert zugewiesen werden, da die Verbindung mit einem Aus dem DefaultID Feld abgerufenen Standardwert erstellt wird.
Um eine Verbindung im Code herzustellen, müssen Entwickler ein neues ProviderConnectionPoint Objekt erstellen, indem sie die GetProviderConnectionPoints -Methode aufrufen und die ID des Anbietersteuerelements zusammen mit der ID oder dem Index des definierten ProviderConnectionPoint Objekts im Anbietersteuerelement übergeben. Das zurückgegebene ProviderConnectionPoint Objekt wird zusammen mit einem Verweis auf das Anbietersteuerelement, einem Verweis auf das Consumersteuerelement und einem entsprechenden ConsumerConnectionPoint Objekt an die ConnectWebParts -Methode übergeben, um ein neues WebPartConnection Objekt zu erstellen.
Obwohl Entwickler Anbieterverbindungspunkte verwenden können, um Verbindungen entweder deklarativ oder programmgesteuert herzustellen, können Benutzer auch mit Anbieterverbindungspunkten interagieren, um Verbindungen über die Benutzeroberfläche (UI) herzustellen. Wenn Entwickler ein ConnectionsZone Steuerelement auf einer Webseite deklarieren, stellt es eine Laufzeitbenutzeroberfläche bereit, auf der Benutzer Verbindungen erstellen können. Wenn Benutzer das Consumer-Steuerelement als Ausgangspunkt für die Verbindungsherstellung auswählen, indem sie auf das Verbindungsverb klicken (sie können auch den Anbieter auswählen; es gibt keinen Unterschied in der resultierenden Verbindung), wird auf der Benutzeroberfläche ein Dropdownlistensteuerelement mit dem Anzeigenamen des verfügbaren Anbieterverbindungspunkts (oder punkte, wenn mehrere vorhanden sind) angezeigt. Benutzer müssen einen Anbieterverbindungspunkt auswählen, um eine Verbindung zu erstellen.
Ein ProviderConnectionPoint -Objekt ordnet einem bestimmten Anbietersteuerelement direkt zu und speichert Details zu einer Verbindung in den Eigenschaften, die es von der Basisklasse ConnectionPoint erbt. In der geerbten InterfaceType Eigenschaft behält beispielsweise ein Anbieterverbindungspunkt den Typ der vom Anbieter zurückgegebenen Schnittstelle bei. Wenn der Anbieter und der Consumer in einer Verbindung beide mit demselben Schnittstellentyp arbeiten, sind die Steuerelemente kompatibel und können eine direkte Verbindung herstellen. Wenn der Anbieter und der Consumer nicht mit demselben Schnittstellentyp arbeiten können, sind sie inkompatibel und müssen ein WebPartTransformer -Objekt verwenden, um den Wert des Anbieterverbindungspunkts InterfaceType in einen Typ zu übersetzen, mit dem der Consumer arbeiten kann. Eine weitere wichtige geerbte Eigenschaft ist die -Eigenschaft, die DisplayName einen Anzeigenamen bereitstellt, der auf der Benutzeroberfläche angezeigt werden soll, damit Benutzer beim Erstellen von Verbindungen einen Anbieterverbindungspunkt auswählen können. Der Anzeigename ist der erforderliche Parameter, wenn Entwickler der Rückrufmethode in einem Anbietersteuerelement ein ConnectionProvider
Attribut hinzufügen. Die geerbte ID Eigenschaft ist auch nützlich, wie oben angegeben, da sie einen eindeutigen Bezeichner für einen Anbieterverbindungspunkt für den Fall bereitstellt, dass ein Anbieter über mehrere Verbindungspunkte verfügt. Ein Anbieter kann mehrere ProviderConnectionPoint Objekte darin definieren. In diesem Fall, wenn Entwickler das ConnectionProvider
Attribut zu einer Methode hinzufügen, sollten sie einen ID-Wert angeben, um jeden Verbindungspunkt zu unterscheiden. Eine weitere wichtige geerbte Eigenschaft ist die -Eigenschaft, die AllowsMultipleConnections angibt, ob ein Anbieterverbindungspunkt gleichzeitig eine Verbindung mit mehreren Consumern herstellen kann. Dieser Eigenschaftswert ist true
standardmäßig für Anbieterverbindungspunkte (für Consumerverbindungspunkte false
hingegen standardmäßig).
Die ProviderConnectionPoint -Klasse fügt den Membern, die sie von der ConnectionPoint -Klasse erbt, mehrere eindeutige Methoden hinzu. Die GetObject -Methode ruft eine Instanz der -Schnittstelle ab, die von der Rückrufmethode an Consumer zurückgegeben wird. Die GetSecondaryInterfaces -Methode ruft zusätzliche Consumerschnittstellen ab, die Teil einer vorhandenen Verbindung sind, aber nicht die Schnittstellen sind, die zum Herstellen der Verbindung verwendet werden.
Konstruktoren
ProviderConnectionPoint(MethodInfo, Type, Type, String, String, Boolean) |
Initialisiert eine neue Instanz der ProviderConnectionPoint-Klasse. |
Eigenschaften
AllowsMultipleConnections |
Ruft einen Wert ab, der angibt, ob ein Verbindungspunkt mehrere Verbindungen gleichzeitig unterstützt. (Geerbt von ConnectionPoint) |
ControlType |
Ruft den Type des Serversteuerelements ab, dem ein Verbindungspunkt zugeordnet ist. (Geerbt von ConnectionPoint) |
DisplayName |
Ruft eine Zeichenfolge ab, die als benutzerfreundlicher Anzeigename dient und einen Verbindungspunkt in der Benutzeroberfläche darstellt. (Geerbt von ConnectionPoint) |
ID |
Ruft eine Zeichenfolge ab, die den Bezeichner für einen Verbindungspunkt enthält. (Geerbt von ConnectionPoint) |
InterfaceType |
Ruft den Typ von der von einem Verbindungspunkt verwendeten Schnittstelle ab. (Geerbt von ConnectionPoint) |
Methoden
Equals(Object) |
Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object) |
GetEnabled(Control) |
Gibt einen Wert zurück, der angibt, ob ein Verbindungspunkt an Verbindungen teilnehmen kann. (Geerbt von ConnectionPoint) |
GetHashCode() |
Fungiert als Standardhashfunktion. (Geerbt von Object) |
GetObject(Control) |
Ruft die Rückrufmethode in einem Anbietersteuerelement auf, das eine an Consumer zurückzugebende Schnittstelleninstanz abruft. |
GetSecondaryInterfaces(Control) |
Ruft eine optionale Auflistung von sekundären Schnittstellen ab, die von einem Anbieterverbindungspunkt unterstützt werden können. |
GetType() |
Ruft den Type der aktuellen Instanz ab. (Geerbt von Object) |
MemberwiseClone() |
Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object) |
ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |