WebPart.Connections-Eigenschaft
Ruft ab oder legt die Verbindungsinformationen, die mit einem verbundenen Webpart gespeichert ist.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
<WebPartStorageAttribute(Storage := Storage.Shared)> _
<BrowsableAttribute(False)> _
Public Property Connections As String
Get
Set
'Usage
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; }
Eigenschaftswert
Typ: System.String
Ein string -Wert, der Verbindungsinformationen angibt. Der Standardwert ist String.Empty für ein nicht verbundene-Webpart.
Hinweise
Die Zeichenfolge, die die Connections -Eigenschaft gibt hat das folgende Format für jede Verbindung mit einem Webpart gespeichert.
ConsumerPartID,ProviderPartID,ConsumerInterfaceName,ProviderInterfaceName,ConsumerIntefaceGroupName,ProviderIntefaceGroupName, XformInfo,CrossPageConnectionID,CrossPageURL,CrossPageInitEventArgs
Dieses Format wird für jede Verbindung mit einem Webpart mit für jede Verbindung getrennt durch Semikolons (;) gespeichert wiederholt. Es sollte kein Semikolon nach der letzten Verbindung gespeichert.
In der folgenden Tabelle werden die einzelnen Teile der Zeichenfolge-Eigenschaft Connections beschrieben.
Name |
Description |
|---|---|
ConsumerPartID |
Die ConnectionID des Empfängers-Webpart. |
ProviderPartID |
Die ConnectionID des Anbieters-Webpart. Jedoch, wenn der Benutzer im Modus für die Personalisierung, ist Wenn die Verbindung wird erstellt, und das Anbieterwebpart ist ein freigegebenen Teil, der nicht bereits eine ConnectionIDverfügt, wird der Webpartinfrastruktur die webPartID -Eigenschaft verwenden um stattdessen das Webpart zu identifizieren. Dies ist, da die ConnectionID nicht zugewiesen und gespeichert, wenn ein Webpart im Modus für die Personalisierung ist. |
ConsumerInterfaceName |
Die interfaceName des Empfängers-Webpart (wie von der RegisterInterface -Methode des Connection-Schnittstelle definiert werden). Es wird eine Zeichenfolge wie sein: myRowConsumer_WPQ_. |
ProviderInterfaceName |
Die interfaceName des Anbieters-Webpart (wie von der RegisterInterface -Methode des Connection-Schnittstelle definiert werden). Es wird eine Zeichenfolge wie sein: myRowProvider_WPQ_. |
ConsumerInterfaceGroupName |
Die interfaceName des Empfängers-Webpart. Diese Einstellung entspricht der ConsumerInterfaceName -Parameter. |
ProviderInterfaceGroupName |
Die interfaceName des Anbieters-Webpart. Diese Einstellung entspricht der ProviderInterfaceName -Parameter. |
XFormInfo |
(Optional) Eine Zeichenfolge, die in der ein Transformator keine Informationen zur Klärung speichern kann muss es seine Logik während der Laufzeit ausführen. Die folgenden Definitionen und Beispiele sind für die von der Webpartinfrastruktur bereitgestellten Transformator.
|
CrossPageConnectionID |
(Optional) Für eine Verbindung seitenübergreifenden ist dies die eindeutige ID der Verbindung auf der anderen Seite, die das Webpart angeschlossen ist. Der Parameter crosspageconnectionid ist eine Guid und muss auf beiden Seiten eindeutig sein. Authoring Tool sollte diese ID zu generieren. |
CrossPageURL |
(Optional) Für eine Verbindung seitenübergreifenden ist dies die URL der Seite mit der das Webpart verbunden ist. |
CrossPageInitEventArgs |
(Optional) Für eine Verbindung seitenübergreifenden ist dies die InitEventArgs Struktur der Schnittstelle in der anderen Seite des Webparts an die formatierte als ein XML-Fragment angeschlossen ist. Es folgt ein Beispiel für eine IFilterConsumerInitEventArgs -Struktur für den Parameter CrossPageInitEventArgs formatiert. <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> Es folgt ein Beispiel für eine IParametersInConsumerInitEventArgs -Struktur für den Parameter CrossPageInitEventArgs formatiert. <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> |
Ein Komma wird verwendet, um die einzelnen Parameter einer Verbindung zu trennen. Ein Semikolon wird verwendet, um die gesamte Verbindungen zu begrenzen. Leerraum darf nicht vor oder nach Trennzeichen. Wenn ein Komma, Semikolon oder Prozentzeichen innerhalb eines anderen Parameter verwendet werden, codiert der Webpartinfrastruktur das Trennzeichen an, wie in der folgenden Tabelle dargestellt.
Trennzeichen |
Codierung |
|---|---|
, |
%2 C |
; |
% 3 B |
% |
25 % |
Der Wert der Connections -Eigenschaft wird nur auf einer Seite (Webpart) einer Verbindung gespeichert, es sei denn, es eine seitenübergreifende Verbindung ist. Für seitenübergreifenden Verbindungen wird die Verbindung mit beiden Seiten einer Verbindung gespeichert. Der Webpartinfrastruktur speichert standardmäßig den Wert der Connections -Eigenschaft mit dem Consumer-Webpart, obwohl die Infrastruktur unterstützt wird, eine Verbindung auf der Anbieterseite für statische Webparts (ein Webpart außerhalb eines Steuerelements WebPartZone ) und für seitenübergreifenden Verbindungen speichern.
Diese Eigenschaft kann nicht durch einzelne Benutzer personalisiert werden. Der Wert von dessen WebPartStorageAttribute ist Storage.Shared, der angibt, dass die Eigenschaft mit demselben Wert für alle Benutzer gespeichert wird. Nur Benutzer mit dem Recht Webseiten schreiben können diese Eigenschaft festlegen. Es kann nur programmgesteuert festgelegt werden.
Beispiele
Es folgt ein Beispiel für eine Connections -Eigenschafteneinstellung für eine direkte Verbindung zwischen ICellProvider und ICellConsumer -Webparts auf derselben Seite-Webpart.
f690a578-6d1b-4d04-b081-011a93fa23bf,332f8676-875b-44eb-a537-8f946edb7e5f,MyCellConsumer_WPQ_,MyCellProvider_WPQ_,MyCellConsumer_WPQ_,MyCellProvider_WPQ_
Es folgt ein Beispiel für Connections Eigenschafteneinstellungen für beide Seiten der seitenübergreifenden Verbindung zwischen einer IFilterConsumer -Webpart und eine IRowProvider -Webparts mithilfe von einen Transformator.
Die Einstellung der Connection -Eigenschaft für das Webpart auf der Seite Source (Quelle ASPX) folgt:
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>
Die Einstellung für die Connection -Eigenschaft für das Webpart auf der Zielseite (Ziel ASPX) folgt:
a93e4d5a-835b-4a80-80c0-a0e23149ed03,69c42cf9-e98b-4f6e-954a-42c7b46ba32e,MyFilterConsumerInterface_WPQ_,RowProviderInterface,MyFilterConsumerInterface_WPQ_,RowProviderInterface,,0e194b89-eaf0-4fcb-93f9-fe6c0a7a88d1,source.aspx,