ConsumerConnectionPoint Construtor
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Inicializa uma nova instância da ConsumerConnectionPoint classe.
public:
ConsumerConnectionPoint(System::Reflection::MethodInfo ^ callbackMethod, Type ^ interfaceType, Type ^ controlType, System::String ^ displayName, System::String ^ id, bool allowsMultipleConnections);
public ConsumerConnectionPoint(System.Reflection.MethodInfo callbackMethod, Type interfaceType, Type controlType, string displayName, string id, bool allowsMultipleConnections);
new System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint : System.Reflection.MethodInfo * Type * Type * string * string * bool -> System.Web.UI.WebControls.WebParts.ConsumerConnectionPoint
Public Sub New (callbackMethod As MethodInfo, interfaceType As Type, controlType As Type, displayName As String, id As String, allowsMultipleConnections As Boolean)
Parâmetros
- callbackMethod
- MethodInfo
O método no controlo do consumidor que devolve uma instância de interface aos consumidores para estabelecer uma ligação.
- controlType
- Type
O Type do controlo do consumidor com o qual o ponto de ligação do consumidor está associado.
- displayName
- String
Um nome de exibição amigável para o ponto de ligação do consumidor que aparece aos utilizadores na interface de utilizador (UI) da ligação.
- id
- String
Um identificador único para o ponto de ligação do consumidor.
- allowsMultipleConnections
- Boolean
Um valor booleano que indica se o ponto de ligação do consumidor pode ter múltiplas ligações simultâneas com os fornecedores.
Exceções
callbackMethod é null.
-ou-
interfaceType é null.
-ou-
controlType é null.
-ou-
displayName é null ou uma cadeia vazia ("").
controlType não é do mesmo tipo que o controlo do consumidor (nem uma classe válida derivada dele).
Exemplos
O exemplo de código seguinte demonstra como derivar a partir da ConsumerConnectionPoint classe para criar um ponto de ligação personalizado ao fornecedor.
O exemplo de código tem três partes:
Um ficheiro fonte que contém um controlo de fornecedor WebPart , um controlo de consumidor WebPart e um objeto personalizado ConsumerConnectionPoint .
Uma página Web que aloja os controlos numa ligação estática.
Uma explicação de como executar o código de exemplo.
A primeira parte do exemplo de código é o código-fonte para os controlos do fornecedor e consumidor WebPart , e uma classe personalizada ConsumerConnectionPoint , chamada TableConsumerConnectionPoint. Note que o construtor da TableConsumerConnectionPoint classe chama o construtor base, passando-lhe os parâmetros necessários conforme indicado na secção de Parâmetros. Note também que, na TableConsumer classe, o SetConnectionInterface método é especificado como método de callback para ligações, e o ConnectionConsumer atributo declara o custom TableConsumerConnectionPoint como parâmetro. Isto demonstra como criar um ponto de ligação personalizado para o consumidor e depois associá-lo a um controlo para o consumidor. Este exemplo assume que o código-fonte é compilado dinamicamente, por isso deve colocar o ficheiro do código-fonte numa App_Code subpasta da sua aplicação Web.
using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Reflection;
using System.Web;
using System.Web.UI;
using System.Security.Permissions;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
//This sample code creates a Web Parts control that acts as a provider of table data.
namespace Samples.AspNet.CS.Controls
{
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public sealed class TableProviderWebPart : WebPart, IWebPartTable
{
DataTable _table;
public TableProviderWebPart()
{
_table = new DataTable();
DataColumn col = new DataColumn();
col.DataType = typeof(string);
col.ColumnName = "Name";
_table.Columns.Add(col);
col = new DataColumn();
col.DataType = typeof(string);
col.ColumnName = "Address";
_table.Columns.Add(col);
col = new DataColumn();
col.DataType = typeof(int);
col.ColumnName = "ZIP Code";
_table.Columns.Add(col);
DataRow row = _table.NewRow();
row["Name"] = "John Q. Public";
row["Address"] = "123 Main Street";
row["ZIP Code"] = 98000;
_table.Rows.Add(row);
}
public PropertyDescriptorCollection Schema
{
get
{
return TypeDescriptor.GetProperties(_table.DefaultView[0]);
}
}
public void GetTableData(TableCallback callback)
{
callback(_table.Rows);
}
public bool ConnectionPointEnabled
{
get
{
object o = ViewState["ConnectionPointEnabled"];
return (o != null) ? (bool)o : true;
}
set
{
ViewState["ConnectionPointEnabled"] = value;
}
}
[ConnectionProvider("Table", typeof(TableProviderConnectionPoint), AllowsMultipleConnections = true)]
public IWebPartTable GetConnectionInterface()
{
return new TableProviderWebPart();
}
public class TableProviderConnectionPoint : ProviderConnectionPoint
{
public TableProviderConnectionPoint(MethodInfo callbackMethod, Type interfaceType, Type controlType,
string name, string id, bool allowsMultipleConnections) : base(
callbackMethod, interfaceType, controlType,
name, id, allowsMultipleConnections)
{
}
public override bool GetEnabled(Control control)
{
return ((TableProviderWebPart)control).ConnectionPointEnabled;
}
}
}
// This code sample demonstrates a custom WebPart controls that acts as
// a consumer in a Web Parts connection.
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class TableConsumer : WebPart
{
private IWebPartTable _provider;
private ICollection _tableData;
private void GetTableData(object tableData)
{
_tableData = (ICollection)tableData;
}
protected override void OnPreRender(EventArgs e)
{
if (_provider != null)
{
_provider.GetTableData(new TableCallback(GetTableData));
}
}
protected override void RenderContents(HtmlTextWriter writer)
{
if (_provider != null)
{
PropertyDescriptorCollection props = _provider.Schema;
int count = 0;
if (props != null && props.Count > 0 && _tableData != null)
{
foreach (PropertyDescriptor prop in props)
{
foreach (DataRow o in _tableData)
{
writer.Write(prop.DisplayName + ": " + o[count]);
}
writer.WriteBreak();
writer.WriteLine();
count = count + 1;
}
}
else
{
writer.Write("No data");
}
}
else
{
writer.Write("Not connected");
}
}
[ConnectionConsumer("Table")]
public void SetConnectionInterface(IWebPartTable provider)
{
_provider = provider;
}
public class TableConsumerConnectionPoint : ConsumerConnectionPoint
{
public TableConsumerConnectionPoint(MethodInfo callbackMethod, Type interfaceType, Type controlType,
string name, string id, bool allowsMultipleConnections)
: base(
callbackMethod, interfaceType, controlType,
name, id, allowsMultipleConnections)
{
}
}
}
}
A segunda parte do exemplo de código é a página Web que aloja os controlos personalizados numa ligação estática de partes Web. No topo da página há uma Register diretiva para declarar um prefixo e o espaço de nomes para os controlos personalizados. A ligação é declarada usando um <asp:webpartconnection> elemento, e os controlos do fornecedor e do consumidor são declarados dentro de um <asp:webpartzone> elemento.
<%@ page language="C#" %>
<%@ 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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
<title>IField Test Page</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<asp:webpartmanager id="WebPartManager1" runat="server">
<StaticConnections>
<asp:WebPartConnection id="wp1" ProviderID="provider1" ConsumerID="consumer1">
</asp:WebPartConnection>
</StaticConnections>
</asp:webpartmanager>
<asp:webpartzone id="WebPartZone1" runat="server">
<zoneTemplate>
<aspSample:TableProviderWebPart ID="provider1" runat="server"
ToolTip="Web Parts Table Provider Control" />
<aspSample:TableConsumer ID="consumer1" runat="server"
ToolTip="Web Parts Table Consumer Control"/>
</zoneTemplate>
</asp:webpartzone>
</div>
</form>
</body>
</html>
Carrega a página num navegador. A ligação entre os controlos já existe, e o consumidor exibe os dados do fornecedor, porque a ligação foi declarada como estática na página.
Observações
O ConsumerConnectionPoint construtor da ConsumerConnectionPoint classe simplesmente chama o construtor base, passando-lhe os vários parâmetros e inicializando a classe base.
O construtor da classe base verifica vários parâmetros para um ponto de ligação e pode lançar várias exceções. Para uma lista de possíveis exceções, consulte a secção Exceções.
Podes chamar o ConsumerConnectionPoint construtor para criar a tua própria instância da ConsumerConnectionPoint classe. No entanto, nos casos em que está apenas a estabelecer uma ligação e não a estender a classe, deve chamar o GetConsumerConnectionPoints método para devolver um objeto de ponto de ligação de um fornecedor.