Freigeben über

WebPartConnection Klasse

  • Referenz

Definition

Namespace:
System.Web.UI.WebControls.WebParts
Assembly:
System.Web.dll

Stellt ein Objekt bereit, das zwei WebPart-Steuerelementen das Herstellen einer Verbindung ermöglicht. Diese Klasse kann nicht vererbt werden.

public ref class WebPartConnection sealed
[System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))]
public sealed class WebPartConnection
[<System.ComponentModel.TypeConverter(typeof(System.ComponentModel.ExpandableObjectConverter))>]
type WebPartConnection = class
Public NotInheritable Class WebPartConnection
Vererbung
Object
WebPartConnection
Attribute
TypeConverterAttribute

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie eine einfache Verbindung zwischen zwei WebPart Steuerelementen erstellt wird. Das Beispiel veranschaulicht drei Möglichkeiten zum Herstellen einer Verbindung: deklarativ, indem Tags für die Verbindung im Markup der Webseite platziert werden; programmgesteuert, indem die Verbindung im Code erstellt wird; und über die Benutzeroberfläche, indem Sie ein ConnectionsZone Steuerelement auf der Seite platzieren, mit dem Benutzer eine Verbindung herstellen können.

Das Codebeispiel 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 zum Hosten aller Steuerelemente und zum Ausführen des Codebeispiels.

  • 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 ganz oben auf 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 Webpartseite.

<%@ 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 mit dem Namen IZipCode. Es gibt auch eine WebPart Klasse namens ZipCodeWebPart , die die Schnittstelle implementiert und als Anbietersteuerelement fungiert. Ihre ProvideIZipCode Methode ist die Rückrufmethode, die das einzige Element der Schnittstelle implementiert. Die -Methode gibt einfach eine Instanz der -Schnittstelle zurück. Beachten Sie, dass die Methode in ihren Metadaten mit einem ConnectionProvider Attribut 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 WeatherWebPartund 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.

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, 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 sich die Register Anweisungen für das Benutzersteuerelement und die benutzerdefinierten WebPart Steuerelemente. Da im Beispiel von der dynamischen Kompilierung der Steuerelemente ausgegangen wird, sollte sich der Quellcode für die Steuerelemente in einem App_Code Unterordner befinden. das Register Tag auf der Seite verweist nur auf ein beliebiges Tagpräfix und den Namespace der Steuerelemente. Die benutzerdefinierten WebPart Steuerelemente (Anbieter und Consumer) werden innerhalb des Elements der Webseite <asp:webpartzone> innerhalb eines <zonetemplate> Elements deklariert.

Die Seite bietet drei Möglichkeiten, eine Verbindung zwischen den benutzerdefinierten Steuerelementen herzustellen. Die erste Methode ist deklarativ. Im Markup für die Seite wird ein <StaticConnections> -Element deklariert, und darin ist ein <asp:WebPartConnections> -Element mit den verschiedenen Consumer- und Anbieterdetails der Verbindung als Attribute angegeben. Dies ist eine Möglichkeit, eine Verbindung zu erstellen, indem Sie sie direkt auf der Webseite deklarieren, insbesondere innerhalb des <asp:WebPartManager> Elements. Aufgrund dieser statischen Verbindung wird sofort beim ersten Laden der Seite eine Verbindung zwischen den beiden benutzerdefinierten Steuerelementen erstellt.

Eine zweite Methode zum Herstellen einer Verbindung zwischen den Steuerelementen wird vom <asp:connectionszone> -Element auf der Seite bereitgestellt. Wenn ein Benutzer eine Seite zur Laufzeit in den Verbindungsanzeigemodus wechselt und auf ein Verbindungsverb auf einem der benutzerdefinierten Steuerelemente klickt, rendert das <asp:connectionszone> Element die Benutzeroberfläche automatisch zum Erstellen einer Verbindung.

Die Seite zeigt auch eine dritte Möglichkeit zum Erstellen einer Verbindung, nämlich programmgesteuert. In der Button1_Click -Methode erstellt der Code ein ProviderConnectionPoint -Objekt für das Anbietersteuerelement und ruft die Verbindungspunktdetails ab, indem die GetProviderConnectionPoints -Methode aufgerufen wird. Es führt eine ähnliche Aufgabe für das Consumersteuerelement aus, indem die GetConsumerConnectionPoints -Methode aufgerufen wird. Schließlich wird das neue WebPartConnection Objekt erstellt, indem die ConnectWebParts -Methode für das WebPartManager -Steuerelement aufgerufen wird.

<%@ 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"];
    WebPartConnection conn1 = mgr.ConnectWebParts(zip1, provPoint,
      weather1, connPoint);
  }

  protected void mgr_DisplayModeChanged(object sender, 
    WebPartDisplayModeEventArgs e)
  {
    if (mgr.DisplayMode == WebPartManager.ConnectDisplayMode)
      Button1.Visible = true;
    else
      Button1.Visible = false;
  }
</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" 
    OnDisplayModeChanged="mgr_DisplayModeChanged">
        <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="Connect WebPart Controls" 
        OnClick="Button1_Click" 
    Visible="false" />
    </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")
    mgr.ConnectWebParts(zip1, provPoint, weather1, connPoint)

  End Sub

  Protected Sub mgr_DisplayModeChanged (ByVal sender as Object, _
    ByVal e as WebPartDisplayModeEventArgs)

    If mgr.DisplayMode Is WebPartManager.ConnectDisplayMode Then
    Button1.Visible = True
    Else
    Button1.Visible = False
    End If

  End Sub
</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" 
    OnDisplayModeChanged="mgr_DisplayModeChanged">
        <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="Connect WebPart Controls" 
        OnClick="Button1_Click" 
    Visible="false" />
    </div>
    </form>
</body>
</html>

Nachdem Sie die Webseite in einem Browser geladen haben, besteht die erste Verbindung bereits, da sie innerhalb des <StaticConnections> Elements deklariert ist. Geben Sie text in das Steuerelement ZIP Code Provider ein, und dieser wird im Consumersteuerelement angezeigt. Trennen Sie als Nächstes die beiden Steuerelemente. Ändern Sie die Seite mithilfe des Dropdownlistensteuerelements Anzeigemodus , um den Anzeigemodus zu verbinden. Klicken Sie für jedes Steuerelement auf das Verbenmenü (dargestellt durch einen Pfeil nach unten in der WebPart Titelleiste), und beachten Sie, dass jedes steuerelement über eine Option Verbinden verfügt. Dies ist ein Verbindungsverb, das im Verbenmenü nur angezeigt wird, wenn sich die Seite im Verbindungsmodus befindet. Klicken Sie in einem der Steuerelemente auf das Verb Verbinden, und die vom ConnectionsZone Steuerelement bereitgestellte Verbindungsoberfläche wird angezeigt. Klicken Sie auf die Schaltfläche Trennen , um die statische Verbindung zwischen den Steuerelementen zu beenden. Verwenden Sie das Steuerelement Anzeigemodus , um die Seite in den Browsermodus zurückzugeben. Versuchen Sie erneut, einen neuen Text im Anbieter einzugeben, und beachten Sie, dass der Text im Consumersteuerelement nicht aktualisiert werden kann, da die Steuerelemente getrennt sind.

Verwenden Sie als Nächstes die gleiche Methode wie oben, um die Seite erneut in den Anzeigemodus für die Verbindung zu wechseln. Klicken Sie in einem der Steuerelemente auf ein Verbindungsverb. Klicken Sie auf den Link Verbindung erstellen , und verwenden Sie die vom ConnectionsZone Steuerelement bereitgestellte Benutzeroberfläche, um eine Verbindung zwischen den Steuerelementen herzustellen. Dies ist die zweite Methode zum Erstellen einer Verbindung. Beachten Sie, dass sobald die Verbindung hergestellt wird, die letzte Zeichenfolge, die Sie im Anbietersteuerelement eingegeben haben (die nicht angezeigt werden konnte, weil die Steuerelemente getrennt wurden) plötzlich im Consumer angezeigt wird, da die Verbindung neu erstellt wurde. Klicken Sie auf die Schaltfläche Trennen , um die aktuelle Verbindung zu beenden, die Sie gerade erstellt haben. Kehren Sie die Seite in den Suchmodus zurück. Geben Sie im Anbieter einen neuen Text ein, um zu veranschaulichen, dass der Text nicht aktualisiert wird und dass die Steuerelemente erneut getrennt sind.

Gibt die Seite zurück, um den Anzeigemodus zu verbinden. Klicken Sie nicht auf ein Verbindungsverb, sondern auf die Schaltfläche WebPart-Steuerelemente verbinden , die die dritte Methode zum Herstellen einer Verbindung veranschaulicht. Dieser Ansatz verbindet die Steuerelemente programmgesteuert in einem einfachen Schritt, ohne das ConnectionsZone Steuerelement verwenden zu müssen. Beachten Sie, dass beim Herstellen der Verbindung die letzte Zeichenfolge, die Sie im Anbieter eingegeben haben, plötzlich im Consumersteuerelement angezeigt wird.

Hinweise

Im Webparts-Steuerelementsatz ist eine Verbindung ein Link oder eine Zuordnung zwischen zwei WebPart Steuerelementen (oder anderen Servern oder Benutzern), die es ihnen ermöglichen, Daten freizugeben. Diese Möglichkeit zum Freigeben von Daten ermöglicht die Verwendung verbundener Steuerelemente auf eine Weise, die die von den isolierten Steuerelementen gebotene Funktionalität übersteigt. Wenn beispielsweise ein Steuerelement Postleitzahldaten bereitstellt und ein anderes Steuerelement diese Daten lesen und lokale Wetterinformationen basierend auf der Postleitzahl bereitstellen kann, bietet die verbundene Funktion der beiden Steuerelemente den Benutzern mehr Wert. Um dieses Beispiel zu erweitern, könnten andere Steuerelemente erstellt werden, die auch Informationen basierend auf einer Postleitzahl anzeigen, z. B. ein Steuerelement mit Links zu lokalen Nachrichten, und alle diese Steuerelemente, die mit Postleitzahldaten arbeiten können, könnten Daten mit dem einzelnen Steuerelement teilen, das eine Postleitzahl bereitstellt. Endbenutzer von Webpartanwendungen können Verbindungen zwischen diesen kompatiblen Steuerelementen direkt über einen Webbrowser erstellen und verwalten, indem sie die vom Steuerelement bereitgestellte Benutzeroberfläche (User Interface, UI) für Standardverbindungen verwenden oder eine benutzerdefinierte Benutzeroberfläche verwenden, die ConnectionsZone von einem Entwickler bereitgestellt wird.

Diese WebPartConnection Klassenübersicht ist eine allgemeine Anweisung der grundlegenden Details zum Erstellen einer Verbindung. Weitere Informationen zu spezifischen Komponenten und Anforderungen, die beim Erstellen von Verbindungen erforderlich sind, finden Sie unter Übersicht über Webpartsverbindungen oder in den Referenzklassen und Codebeispielen, die in der folgenden Diskussion erwähnt werden. Es gibt mehrere grundlegende Aspekte einer Webpartverbindung:

  • Zwei WebPart-Steuerelemente. Jede Webpartverbindung besteht aus zwei Steuerelementen. Es ist möglich, dass ein Steuerelement an mehr als einer Verbindung gleichzeitig teilnimmt, aber jede einzelne Verbindung besteht aus genau zwei Steuerelementen. Die Steuerelemente können direkt von der WebPart Basisklasse abgeleitet werden, oder es können sich um andere Serversteuerelemente handeln, einschließlich ASP.NET-Steuerelemente, benutzerdefinierte Serversteuerelemente und Benutzersteuerelemente. Steuerelemente, die nicht von der WebPart -Klasse abgeleitet sind, werden, wenn sie in einer WebPartZoneBase Zone platziert werden, automatisch zur Laufzeit mit einem GenericWebPart Objekt umschlossen, sodass sie von der WebPart -Klasse erben und als Laufzeitsteuerelemente WebPart fungieren können.

  • Steuerelemente, die sich in WebPartZoneBase Zonen befinden. Sowohl Steuerelemente als auch WebPart alle anderen Arten von Serversteuerelementen müssen sich in einer WebPartZoneBase Zone befinden, um an Webpartverbindungen (und den meisten anderen Webparts-Features) teilnehmen zu können.

  • Verbraucher und Anbieter. In jeder Webpartverbindung gibt es zwei Steuerelemente: einen Datenanbieter und einen Consumer von Daten. Der Anbieter stellt Daten an den Consumer über eine angegebene Rückrufmethode bereit, die Daten in Form einer Schnittstelle zurückgibt. (Ein Beispiel zum Erstellen und Angeben der Rückrufmethode finden Sie im Abschnitt Beispiel dieses Themas.) Diese Rückrufmethode wird als Anbieterverbindungspunkt bezeichnet. Die Details dieses Verbindungspunkts (dessen "Anzeigename", eine ID und der Typ der zurückgegebenen Schnittstelle) sind in einem ProviderConnectionPoint Objekt enthalten, das dem Anbietersteuerelement zugeordnet ist. Der Consumer empfängt die Daten über eine angegebene Methode, die eine Instanz der Schnittstelle akzeptieren kann. Diese Methode wird als Consumerverbindungspunkt bezeichnet, und die Details des Verbindungspunkts (Name, ID und Typ der Schnittstelle) sind in einem ConsumerConnectionPoint Objekt enthalten, das dem Consumersteuerelement zugeordnet ist.

  • Kompatible Steuerelemente oder ein gültiger Transformator. Damit eine Verbindung funktioniert, müssen Consumer und Anbieter entweder kompatibel sein (was bedeutet, dass die angegebenen Verbindungspunktmethoden mit demselben Schnittstellentyp arbeiten können), oder es muss ein WebPartTransformer Objekt vorhanden sein, das den vom Anbieter angebotenen Typ in einen vom Consumer verstandenen Typ übersetzen kann.

  • Ein WebPartConnection-Objekt. Damit eine Verbindung vorhanden ist, muss eine Instanz der -Klasse vorhanden sein, die WebPartConnection Verweise auf die Anbieter- und Consumersteuerelemente sowie die Details ihrer Verbindungspunkte enthält. Wenn Anbieter und Consumer inkompatibel sind und stattdessen ein Objekt zum Herstellen einer WebPartTransformer Verbindung verwenden, verweist die Verbindung auf den Transformator.

  • Ein Mittel zum Herstellen der Verbindung. Nachdem kompatible Consumer- und Anbietersteuerelemente ordnungsgemäß mit Verbindungspunktmethoden entworfen und in einer Zone platziert wurden und ein WebPartConnection Objekt verfügbar ist, besteht der letzte grundlegende Schritt darin, die Verbindung zu initiieren. Eine Möglichkeit, dies zu erreichen, besteht darin, dass Benutzer die Verbindung über die Benutzeroberfläche erstellen. Wenn Sie ein <asp:connectionszone> Element auf der Seite platzieren und die anderen erforderlichen Komponenten für eine Verbindung vorhanden sind, kann ein Benutzer zur Laufzeit die Seite in den Verbindungsanzeigemodus wechseln, im Verbenmenü des Anbieters oder Consumers auf ein Verbindungsverb klicken, und eine Verbindungsoberfläche (basierend auf dem ConnectionsZone Steuerelement) wird angezeigt. Über diese Benutzeroberfläche kann der Benutzer die Verbindung initiieren. Eine andere Möglichkeit, die Verbindung zu initiieren, besteht darin, sie programmgesteuert durchzuführen. In beiden Fällen , ob über die Benutzeroberfläche oder programmgesteuert, ist die zugrunde liegende Methode, die die Verbindung initiiert, identisch. Die Anwendung ruft die ConnectWebParts -Methode (oder die ConnectWebParts -Methode bei Verwendung eines Transformators) für das WebPartManager -Steuerelement auf und übergibt ihr den Anbieter, den Consumer und die entsprechenden Verbindungspunktobjekte, und die -Methode gibt ein WebPartConnection -Objekt zurück.

Die WebPartConnection -Klasse definiert ein -Objekt, das die wesentlichen Details einer Verbindung zwischen zwei WebPart Steuerelementen kapselt. Die -Klasse besteht fast ausschließlich aus Eigenschaften, die sich auf die Details einer bestimmten Verbindung beziehen. Mehrere Eigenschaften betreffen das Consumersteuerelement in einer Verbindung. Die Consumer Eigenschaft verweist auf das Consumersteuerelement selbst, und die ConsumerID Eigenschaft verweist auf die ID des Consumers. Auf ConsumerConnectionPoint das Objekt, das die Details des Verbindungspunkts des Consumers enthält, wird von der Eigenschaft des Consumers ConsumerConnectionPoint verwiesen. Die ConsumerConnectionPointID -Eigenschaft verweist auf die ID des ConsumerConnectionPoint -Objekts. Allen diesen consumerbezogenen Verbindungseigenschaften muss ein Wert zugewiesen sein, um eine Verbindung zu erstellen.

Die WebPartConnection -Klasse verfügt auch über mehrere Eigenschaften, die sich auf das Anbietersteuerelement in einer Verbindung beziehen, und diese entsprechen den Eigenschaften für einen Consumer. Die Provider -Eigenschaft verweist auf das Anbietersteuerelement selbst, während die ProviderID -Eigenschaft auf seine ID verweist. Die ProviderConnectionPoint -Eigenschaft verweist auf das ProviderConnectionPoint -Objekt und die ProviderConnectionPointID -Eigenschaft auf die ID des Verbindungspunkts des Anbieters.

Mehrere Eigenschaften betreffen den Zustand der Verbindung. Die IsActive -Eigenschaft gibt an, ob die Verbindung aktiv (derzeit Daten austauscht) oder inaktiv (weiterhin verbunden, aber nicht aktiv datenfreigaben) ist. Die IsShared -Eigenschaft gibt an, ob die Verbindung eine freigegebene (für alle Benutzer einer Seite verfügbar) oder eine benutzerspezifische Verbindung ist, und die IsStatic -Eigenschaft gibt an, ob das Steuerelement statisch (im Seitenmarkup deklariert und somit dauerhaft) oder dynamisch (programmgesteuert erstellt, was bedeutet, dass es gelöscht werden kann).

Konstruktoren

WebPartConnection()

Initialisiert eine neue Instanz der WebPartConnection-Klasse.

Eigenschaften

Consumer

Ruft ein WebPart-Objekt ab, das in einer Verbindung als Consumersteuerelement fungiert.
ConsumerConnectionPoint

Ruft das Objekt ab, das als Verbindungspunkt für ein Steuerelement fungiert, das als Consumer in einer Verbindung fungiert.
ConsumerConnectionPointID

Ruft den Eigenschaftswert für eine Verbindung ab, der auf die ID des Objekts verweist, das als Consumerverbindungspunkt für diese Verbindung fungiert, oder legt diesen fest.
ConsumerID

Ruft den Eigenschaftswert für eine Verbindung ab, der auf die ID des WebPart-Steuerelements verweist, das als Consumer für diese Verbindung fungiert, oder legt diesen fest.
ID

Ruft die ID eines WebPartConnection-Objekts ab oder legt diese fest.
IsActive

Ruft einen Wert ab, der angibt, ob ein WebPartConnection-Objekt derzeit eingerichtet und in der Lage ist, Daten zwischen seinem Anbieter- und seinem Consumersteuerelement auszutauschen.
IsShared

Ruft einen Wert ab, der angibt, ob ein WebPartConnection-Objekt für alle Benutzer oder nur für den aktuellen Benutzer sichtbar ist.
IsStatic

Ruft einen Wert ab, der angibt, ob ein WebPartConnection-Objekt im Markup einer Webseite deklariert ist oder programmgesteuert erstellt wird.
Provider

Ruft ein WebPart-Steuerelement ab, das in einer Webparts-Verbindung als Anbieter fungiert.
ProviderConnectionPoint

Ruft das Objekt ab, das als Verbindungspunkt für ein WebPart-Steuerelement fungiert, das als Anbieter in einer Verbindung fungiert.
ProviderConnectionPointID

Ruft den Eigenschaftswert für eine Verbindung ab, der auf die ID des Objekts verweist, das als Anbieterverbindungspunkt für diese Verbindung fungiert, oder legt diesen fest.
ProviderID

Ruft den Eigenschaftswert für eine Verbindung ab, der auf die ID des WebPart-Steuerelements verweist, das als Anbieter für diese Verbindung fungiert, oder legt diesen fest.
Transformer

Ruft ein WebPartTransformer-Objekt ab, mit dessen Hilfe Daten zwischen zwei andernfalls nicht kompatiblen Verbindungspunkten in einer Webparts-Verbindung transformiert werden.
Transformers

Ruft eine Auflistung von WebPartTransformer-Objekten ab, die vom Webparts-Steuerelementsatz intern verwendet wird.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
ToString()

Überschreibt die geerbte ToString()-Methode und gibt einen kurzen Typnamen für das Verbindungsobjekt zurück.

Gilt für:

Weitere Informationen