WebPart.Connections property
Obtém ou define as informações de conexão que são armazenadas com uma Web Part.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaração
<WebPartStorageAttribute(Storage := Storage.Shared)> _
<BrowsableAttribute(False)> _
Public Property Connections As String
Get
Set
'Uso
Dim instance As WebPart
Dim value As String
value = instance.Connections
instance.Connections = value
[WebPartStorageAttribute(Storage = Storage.Shared)]
[BrowsableAttribute(false)]
public string Connections { get; set; }
Property value
Type: System.String
Um valor de string que especifica as informações de conexão. O valor padrão é String.Empty para uma Web Part não conectadas.
Comentários
A cadeia de caracteres que especifica a propriedade Connections tem o seguinte formato para cada conexão armazenada com uma Web Part.
ConsumerPartID,ProviderPartID,ConsumerInterfaceName,ProviderInterfaceName,ConsumerIntefaceGroupName,ProviderIntefaceGroupName, XformInfo,CrossPageConnectionID,CrossPageURL,CrossPageInitEventArgs
Esse formato é repetido para cada conexão armazenada com uma Web Part com cada conexão separado por ponto e vírgula (;). Não deve haver nenhum ponto e vírgula após a última conexão armazenada.
A tabela a seguir descreve cada uma das partes da cadeia de caracteres de propriedade Connections .
Nome |
Descrição |
|---|---|
ConsumerPartID |
ConnectionID de Web Part do consumidor. |
ProviderPartID |
ConnectionID do provedor de Web Part. No entanto, se o usuário está no modo de personalização, quando a conexão é criada, e o provedor de Web Part é uma parte compartilhada que ainda não tiver um ConnectionID, a infra-estrutura de Web Part usará a propriedade webPartID para identificar a Web Part em vez disso. Isso ocorre porque o ConnectionID não pode ser atribuído e salvo quando uma Web Part está no modo de personalização. |
ConsumerInterfaceName |
interfaceName do consumidor Web Part (conforme definido pelo método RegisterInterface da interface da conexão). Será uma cadeia de caracteres, como: myRowConsumer_WPQ_. |
ProviderInterfaceName |
interfaceName do provedor de Web Part (conforme definido pelo método RegisterInterface da interface da conexão). Será uma cadeia de caracteres, como: myRowProvider_WPQ_. |
ConsumerInterfaceGroupName |
interfaceName de Web Part do consumidor. Essa configuração é idêntica do parâmetro ConsumerInterfaceName . |
ProviderInterfaceGroupName |
interfaceName do provedor de Web Part. Essa configuração é idêntica do parâmetro ProviderInterfaceName . |
XFormInfo |
(Opcional) Uma cadeia de caracteres no qual um transformador pode salvar qualquer informação Desambigüidade precisa para executar sua respectiva lógica durante o tempo de execução. As definições e os exemplos a seguir são para os transformadores fornecidos com a infra-estrutura de Web Part.
|
CrossPageConnectionID |
(Opcional) Para uma conexão entre páginas, este é o identificador exclusivo da conexão na página à qual a Web Part estiver sendo conectada. O parâmetro crosspageconnectionid é um Guid e deve ser exclusivo em ambas as páginas. A ferramenta de criação deve gerar essa ID. |
CrossPageURL |
(Opcional) Para uma conexão entre páginas, esta é a URL da página à qual a Web Part está conectada. |
CrossPageInitEventArgs |
(Opcional) Para uma conexão entre páginas, esta é a estrutura de InitEventArgs da interface na outra página à qual a Web Part está conectada formatada como um fragmento XML. O exemplo a seguir é um exemplo de uma estrutura de IFilterConsumerInitEventArgs formatado para o parâmetro CrossPageInitEventArgs . <FilterConsumerInitEventArgs>><Field FieldName="First Name" FieldDisplayName="First Name"/><Field FieldName="Surname" FieldDisplayName="Sur Name"/><Field FieldName="Phone" FieldDisplayName="Phone Number"/><Field FieldName="Company" FieldDisplayName="Company"/></FilterConsumerInitEventArgs> O exemplo a seguir é um exemplo de uma estrutura de IParametersInConsumerInitEventArgs formatado para o parâmetro CrossPageInitEventArgs . <ParametersInConsumerInitEventArgs><Parameter ParameterName="LName" ParameterDisplayName="Last Name" Required="True" Description="Last Name of an employee."><Parameter ParameterName="FName" ParameterDisplayName="First Name" Required="True" Description="First Name of an employee."><Parameter ParameterName="Co" ParameterDisplayName="Company" Required="False" Description="Company the employee previously worked for."><Parameter ParameterName="Phone" ParameterDisplayName="Business Phone" Required="False" Description="Business Phone Number of an employee."></ParametersInConsumerInitEventArgs> |
Uma vírgula é usada para delimitar parâmetros individuais de uma conexão. Um ponto e vírgula é usado para delimitar conexões inteiros. Espaço em branco não é permitido antes ou depois delimitadores. Se uma vírgula, um ponto e vírgula ou um sinal de porcentagem é usados em qualquer um dos parâmetros, a infra-estrutura de Web Part codifica o delimitador, conforme mostrado na tabela a seguir.
Delimitador |
Codificação |
|---|---|
, |
%2 C |
; |
% 3B |
% |
% 25 |
O valor da propriedade Connections é armazenado em um só lado (Web Part) de uma conexão, a menos que é uma conexão entre páginas. Para conexões entre páginas, a conexão será armazenada com ambos os lados de uma conexão. Por padrão, a infra-estrutura de Web Part armazena o valor da propriedade Connections com a Web Part do consumidor, embora a infra-estrutura suportará armazenar uma conexão do lado do provedor para Web Parts estáticas (uma Web Part fora de um controle WebPartZone ) e para conexões entre páginas.
Essa propriedade não pode ser personalizada por usuários individuais. O valor de sua WebPartStorageAttribute é Storage.Shared, que especifica que a propriedade é armazenada com o mesmo valor para todos os usuários. Somente os usuários com o direito de gravar páginas da web podem definir essa propriedade. Ela pode ser definida somente por meio de programação.
Examples
O exemplo a seguir é um exemplo de uma configuração de propriedade Connections para uma conexão direta entre ICellProvider e ICellConsumer Web Parts na mesma página da Web Part.
f690a578-6d1b-4d04-b081-011a93fa23bf,332f8676-875b-44eb-a537-8f946edb7e5f,MyCellConsumer_WPQ_,MyCellProvider_WPQ_,MyCellConsumer_WPQ_,MyCellProvider_WPQ_
O exemplo a seguir é um exemplo de configurações de propriedade de Connections para ambos os lados de uma conexão entre páginas entre um IFilterConsumer Web Part e um IRowProvider Web Part usando um transformador.
A seguir, a configuração da propriedade Connection para a Web Part na página de origem (origem ASPX):
a93e4d5a-835b-4a80-80c0-a0e23149ed03,69c42cf9-e98b-4f6e-954a-42c7b46ba32e,MyFilterConsumerInterface_WPQ_,RowProviderInterface,MyFilterConsumerInterface_WPQ_,RowProviderInterface,Surname=Last%20Name,0e194b89-eaf0-4fcb-93f9-fe6c0a7a88d1,target.aspx,<FilterConsumerInitEventArgs>><Field FieldName="First Name" /><Field FieldName="Surname" /><Field FieldName="Phone" /><Field FieldName="Company" /></FilterConsumerInitEventArgs>
A seguir, a configuração da propriedade Connection para a Web Part na página de destino (destino ASPX):
a93e4d5a-835b-4a80-80c0-a0e23149ed03,69c42cf9-e98b-4f6e-954a-42c7b46ba32e,MyFilterConsumerInterface_WPQ_,RowProviderInterface,MyFilterConsumerInterface_WPQ_,RowProviderInterface,,0e194b89-eaf0-4fcb-93f9-fe6c0a7a88d1,source.aspx,