ConsumerConnectionPoint Klass

Definition

public ref class ConsumerConnectionPoint : System::Web::UI::WebControls::WebParts::ConnectionPoint

public class ConsumerConnectionPoint : System.Web.UI.WebControls.WebParts.ConnectionPoint

type ConsumerConnectionPoint = class
    inherit ConnectionPoint

Public Class ConsumerConnectionPoint
Inherits ConnectionPoint

Arv

Object

ConnectionPoint

ConsumerConnectionPoint

Exempel

I följande kodexempel visas enkla sätt att skapa en anslutning deklarativt, programmatiskt eller via användargränssnittet, i varje fall med hjälp av en konsumentanslutningspunkt.

Exemplet har fyra delar:

• En användarkontroll som gör att du kan ändra visningsläget för webbdelar på en sida.

• Källkod för ett gränssnitt och två WebPart kontroller som fungerar som provider och konsument för en anslutning.

• En webbsida som är värd för alla kontroller och kör kodexemplet.

• En förklaring av hur du kör exempelsidan.

Den första delen av det här kodexemplet är användarkontrollen som gör det möjligt för användare att ändra visningslägen på en webbsida. Spara följande källkod i en .ascx-fil, vilket ger den det filnamn som har tilldelats till Src -attributet för direktivet för den Register här användarkontrollen, som ligger längst upp på värdwebbsidan. Mer information om visningslägen och en beskrivning av källkoden i den här kontrollen finns i Genomgång: Ändra visningslägen på en webbsida.

<%@ 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>

Den andra delen av kodexemplet är källkoden för gränssnittet och kontrollerna. Källfilen innehåller ett enkelt gränssnitt med namnet IZipCode. Det finns också en WebPart klass med namnet ZipCodeWebPart som implementerar gränssnittet och fungerar som providerkontroll. Den andra WebPart klassen heter WeatherWebPartoch fungerar som konsument för anslutningen. Den här klassen har en metod med namnet GetZipCode som hämtar en instans av IZipCode gränssnittet från providerkontrollen. Observera att den här metoden är markerad som konsumentens anslutningspunktsmetod med ett ConnectionConsumer attribut i dess metadata. Det här är mekanismen för att identifiera anslutningspunktsmetoden i konsumentkontrollen.

För att kodexemplet ska köras måste du kompilera den här källkoden. Du kan kompilera den explicit och placera den resulterande sammansättningen i webbplatsens bin-mapp eller den globala sammansättningscacheminnet. Du kan också placera källkoden i webbplatsens App_Code mapp, där den kompileras dynamiskt vid körning. I det här kodexemplet används dynamisk kompilering. En genomgång som visar hur du kompilerar finns i Genomgång: Utveckla och använda en anpassad webbserverkontroll.

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

Den tredje delen av kodexemplet är webbsidan. Längst upp finns Register direktiv för att registrera de anpassade kontroller som utgör anslutningen och användarkontrollen som gör det möjligt för användare att ändra visningslägen på sidan. Själva anslutningen skapas deklarativt i elementet <staticconnections> på sidan. Detta visar ett sätt att skapa en anslutning – observera ConsumerConnectionPointID attributet i elementet <asp:webpartconnection> . Du kan också skapa anslutningen programmatiskt. koden för att göra det finns i Button1_Click -metoden. I det här fallet skapas ett ConsumerConnectionPoint objekt och skickas sedan till en metod som skapar den faktiska anslutningen. Oavsett om anslutningen skapas deklarativt eller programmatiskt måste anslutningspunkter alltid anges för både providern och konsumenten. Metoden Button2_Click kommer åt objekten ConnectionPoint för både providern och konsumenten och skriver några av deras egenskapsvärden till en etikett på sidan.

<%@ 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>

När du har läst in sidan i en webbläsare klickar du på knappen Information om anslutningspunkt . Information om de provider- och konsumentanslutningspunkter som upprättats i den deklarativa anslutningen visas. Använd sedan listrutan Visningsläge för att växla sidan till anslutningsläge. Klicka på anslutningsverb på verbmenyn i kontrollen postnummerproviderWebPart (representeras av en nedåtpil i namnlisten). Anslutningsgränssnittet visas och skapas automatiskt av kontrollen <asp:connectionszone> som deklareras på sidan. Det här är ett annat sätt att skapa en anslutning (via användargränssnittet) tillsammans med de deklarativa och programmatiska metoder som beskrevs tidigare. Klicka på knappen Koppla från för att avsluta den befintliga statiska anslutningen. Klicka på länken Skapa en anslutning till en konsument . Användargränssnittet visar nu en listruta som visar visningsnamnet för konsumentanslutningspunkten. Välj anslutningspunkten i listrutan och klicka sedan på Anslut för att slutföra anslutningen. Klicka sedan på Koppla från igen. Klicka på knappen Dynamisk anslutning för att skapa en anslutning programmatiskt. Använd kontrollen Visningsläge för att returnera sidan för att bläddra. Klicka på knappen Information om anslutningspunkt igen för att ange information om objektet för konsumentanslutningspunkten igen.

Exemplet har visat hur du upprättar en anslutning och använder en konsumentanslutningspunkt på tre sätt: en statisk anslutning som deklareras i webbplatsmarkeringen; en anslutning som skapats i kod som använde ett ConsumerConnectionPoint objekt och en anslutning som skapats av en användare via anslutningsgränssnittet.

Kommentarer

I varje webbdelsanslutning mellan två serverkontroller måste varje kontroll ha (bland andra krav) ett associerat anslutningspunktsobjekt som gör att den kan ansluta till den andra kontrollen och antingen tillhandahålla eller använda data, beroende på om kontrollen är utsedd till provider eller konsument för anslutningen. Ett ConnectionPoint objekt i allmänhet innehåller information om hur en kontroll kan ansluta till en annan kontroll och vilken typ av data den kan dela. För en kontroll som fungerar som konsument i en anslutning måste dess anslutningspunkt vara ett ConsumerConnectionPoint objekt. Mer information om anslutningar och anslutningspunkter för webbdelar finns i avsnitten i avsnittet Se även nedan.

För att skapa ett ConsumerConnectionPoint objekt krävs flera steg:

1. Aktivera en konsumentkontroll för att referera till en gränssnittsinstans. En WebPart eller annan serverkontroll (alla typer av serverkontroll som läggs till i en WebPartZoneBase zon kan användas) måste kunna använda data från en specifik gränssnittsinstans. Kontrollen behöver inte implementera gränssnittet. endast leverantören måste implementera den. Konsumenten kan antingen arbeta med den exakta gränssnittstyp som hanteras av en leverantör eller, om den inte gör det, kan ett WebPartTransformer objekt användas för att transformera data från en leverantörs gränssnittstyp till en typ som konsumenten förstår. Ett vanligt sätt att aktivera en konsument är att deklarera ett privat fält som innehåller en referens till önskad gränssnittstyp.

2. Identifiera en motringningsmetod. En metod i konsumenten måste identifieras som återanropsmetod för att upprätta en anslutning till providern. Den här metoden hämtar en instans av gränssnittet som providern implementerar och tilldelar den till (till exempel) det privata fält som skapades i det första steget. Metoden Webbdelar för att identifiera en motringningsmetod i konsumenten är att lägga till ett ConnectionConsumer metadataattribut (definierat av ConnectionConsumerAttribute klassen) till den metod som tar emot gränssnittsinstansen. När attributet läggs till är den enda obligatoriska parametern ett visningsnamn som ska användas för konsumentanslutningspunkten. Valfria parametrar kan också läggas till, till exempel ett ID.

3. Bearbeta och mata ut data från gränssnittsinstansen. Utför eventuell intern bearbetning efter behov på data, och då återges vanligtvis en konsumentkontroll till sidan. Ett vanligt sätt att göra detta är att åsidosätta kontrollens OnPreRender metod.

   Note

   Under en synkron begäran bör en konsument begära data direkt från providern under eller omedelbart efter händelsen PreRender . Om leverantörens återanropsmetod inte anropas någon gång under återgivningen under en asynkron begäran kan utvecklaren anta att inga data skickades till konsumenten under återgivningen.

När en kontroll har utrustats för att fungera som konsument kan kontrollen delta i anslutningar (förutsatt att en leverantörskontroll också är utrustad och tillgänglig). Utvecklare kan använda <asp:webpartconnection> elementet för att skapa en statisk, deklarativ anslutning i markering av en webbsida. ConnectionConsumer Om attributet i konsumentens källkod som identifierar motringningsmetoden anger ett ID för anslutningspunkten måste det värdet tilldelas attributet ConsumerConnectionPointID i elementet <asp:webpartconnection> på en sida. En orsak till att en utvecklare kan ange ett ID för en konsumentanslutningspunkt är om det finns flera anslutningspunkter som definierats i konsumentkontrollen. Om ett ID inte har angetts för konsumentanslutningspunkten i konsumentkontrollen behöver inget värde heller tilldelas attributet ConsumerConnectionPointID på sidan, eftersom anslutningen skapas med ett standardvärde som hämtas från DefaultID fältet.

För att skapa en anslutning i kod måste utvecklare skapa ett nytt ConsumerConnectionPoint objekt genom att anropa GetConsumerConnectionPoints metoden och skicka ID:t för konsumentkontrollen till den, tillsammans med ID:t eller indexet för det definierade ConsumerConnectionPoint objektet i konsumentkontrollen. Det returnerade ConsumerConnectionPoint objektet, tillsammans med en referens till konsumentkontrollen, en referens till providerkontrollen och ett motsvarande ProviderConnectionPoint objekt, skickas alla till ConnectWebParts metoden för att skapa ett nytt WebPartConnection objekt.

Även om utvecklare kan använda konsumentanslutningspunkter som en del av att upprätta anslutningar antingen deklarativt eller programmatiskt, kan användarna också interagera med konsumentanslutningsplatser för att upprätta anslutningar via användargränssnittet (UI). Om utvecklare deklarerar en ConnectionsZone kontroll på en webbsida, tillhandahåller den ett körningsgränssnitt som användarna kan använda för att skapa anslutningar. Om användarna väljer providerkontrollen som startpunkt för att upprätta anslutningen genom att klicka på dess anslutningsverb (de kan också välja konsument, det finns ingen skillnad i den resulterande anslutningen), i användargränssnittet visas en listruta med visningsnamnen för den tillgängliga konsumentanslutningspunkten (eller punkter om det finns flera) som leverantören kan skicka data till. Användare måste välja en konsumentanslutningspunkt för att upprätta en anslutning.

Ett ConsumerConnectionPoint objekt associeras direkt med en specifik konsumentkontroll och lagrar information om en anslutning i egenskaperna som det ärver från basklassen ConnectionPoint . I den ärvda InterfaceType egenskapen behåller till exempel en konsumentanslutningspunkt den typ av gränssnitt som används. Om både providern och konsumenten i en anslutning förstår gränssnittstypen är kontrollerna kompatibla och kan bilda en direktanslutning. Om providern och konsumenten inte kan arbeta med samma gränssnittstyp är de inkompatibla och måste använda ett WebPartTransformer objekt för att översätta provideranslutningspunktens InterfaceType egenskap till en typ som konsumenten kan arbeta med. En annan viktig ärvd egenskap är egenskapen DisplayName , som ger ett eget namn att visa i användargränssnittet så att användarna kan välja en konsumentanslutningspunkt när de skapar anslutningar. Visningsnamnet är den obligatoriska parametern när utvecklare lägger till ett ConnectionConsumer attribut till motringningsmetoden i en konsumentkontroll. Den ärvda ID egenskapen är också användbar, som anges ovan, eftersom den ger en unik identifierare för en konsumentanslutningspunkt om en konsument har flera anslutningspunkter. En konsument kan ha flera ConsumerConnectionPoint objekt definierade i den, och i det här fallet, när utvecklare lägger till ConnectionConsumer attributet till en metod, bör de ange ett ID-värde för att särskilja varje anslutningspunkt. En annan viktig ärvd egenskap är egenskapen AllowsMultipleConnections , som anger om en konsumentanslutningspunkt kan ansluta samtidigt till flera leverantörer. Det här egenskapsvärdet är false som standard för konsumentanslutningspunkter (medan det är standard för true provideranslutningspunkter).

Klassen ConsumerConnectionPoint lägger till flera unika metoder till de medlemmar som den ärver från ConnectionPoint klassen. Metoden SetObject anropar konsumentens egen definierade återanropsmetod för att hämta gränssnittsinstansen från providern. Metoden SupportsConnection returnerar ett booleskt värde som anger om anslutningspunkten kan upprätta anslutningar, baserat på det aktuella tillståndet för den associerade konsumentkontrollen.

Se även

• WebPartConnection
• ProviderConnectionPoint
• ASP.NET webbdelskontroller
• Översikt över webbdelsanslutningar