WebPart.Connections - Propriété
Obtient ou définit les informations de connexion qui sont stockées avec un composant WebPart connecté.
Espace de noms : Microsoft.SharePoint.WebPartPages
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
<WebPartStorageAttribute(Storage := Storage.Shared)> _
<BrowsableAttribute(False)> _
Public Property Connections As String
Get
Set
'Utilisation
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; }
Valeur de propriété
Type : System.String
Une valeur string qui spécifie les informations de connexion. La valeur par défaut est String.Empty pour un composant WebPart non reliées entre elles.
Remarques
La chaîne qui spécifie la propriété Connections possède le format suivant pour chaque connexion stockée avec un composant WebPart.
ConsumerPartID,ProviderPartID,ConsumerInterfaceName,ProviderInterfaceName,ConsumerIntefaceGroupName,ProviderIntefaceGroupName, XformInfo,CrossPageConnectionID,CrossPageURL,CrossPageInitEventArgs
Ce format est répété pour chaque connexion stockée avec un composant WebPart avec chaque connexion séparée par des points-virgules (;). Il ne doit exister aucun point-virgule après la dernière connexion stockée.
Le tableau suivant décrit chacun des composants de la chaîne de la propriété Connections .
Name |
Description |
|---|---|
ConsumerPartID |
ConnectionID du composant WebPart consommateur. |
ProviderPartID |
ConnectionID du composant WebPart fournisseur. Toutefois, si l'utilisateur est en mode de personnalisation lors de la connexion est créée, et le composant WebPart fournisseur est un composant partagé qui n'a pas déjà un ConnectionID, l'infrastructure WebPart utilisera la propriété webPartID pour identifier le composant WebPart à la place. Il s'agit, car le ConnectionID ne peut pas être affectée et enregistré lorsqu'un composant WebPart est en mode de personnalisation. |
ConsumerInterfaceName |
interfaceName du consommateur WebPart (tel que défini par la méthode RegisterInterface de l'interface de connexion). Elle sera une chaîne telle que : myRowConsumer_WPQ_. |
ProviderInterfaceName |
interfaceName du fournisseur de composant WebPart (tel que défini par la méthode RegisterInterface de l'interface de connexion). Elle sera une chaîne telle que : myRowProvider_WPQ_. |
ConsumerInterfaceGroupName |
interfaceName du composant WebPart consommateur. Ce paramètre est identique à celle du paramètre ConsumerInterfaceName . |
ProviderInterfaceGroupName |
interfaceName du composant WebPart fournisseur. Ce paramètre est identique à celle du paramètre ProviderInterfaceName . |
XFormInfo |
(Facultatif) Une chaîne dans laquelle un transformateur peut enregistrer des informations de levée d'ambiguïté dont il a besoin pour effectuer ses logique pendant l'exécution. Les définitions et les exemples suivants sont pour les convertisseurs fournis avec l'infrastructure de composant WebPart.
|
CrossPageConnectionID |
(Facultatif) Pour une connexion entre pages, il s'agit de l'identificateur unique de la connexion de l'autre page à laquelle le composant WebPart est en cours de connexion. Le paramètre crosspageconnectionid est une Guid et doit être unique sur les deux pages. L'outil de création doit générer ce code. |
CrossPageURL |
(Facultatif) Pour une connexion entre pages, il s'agit de l'URL de la page à laquelle le composant WebPart est connecté. |
CrossPageInitEventArgs |
(Facultatif) Pour une connexion entre pages, il s'agit de la structure InitEventArgs de l'interface de l'autre page à laquelle le composant WebPart est en cours de connexion mises en forme en tant que fragment XML. Voici un exemple d'une structure IFilterConsumerInitEventArgs mis en forme pour le paramètre 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> Voici un exemple d'une structure IParametersInConsumerInitEventArgs mis en forme pour le paramètre 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> |
Une virgule est utilisée pour délimiter des paramètres individuels d'une connexion. Un point-virgule est utilisé pour délimiter les connexions entière. Espace blanc n'est pas autorisé avant ou après les délimiteurs. Si une virgule, un point-virgule ou un symbole de pourcentage est utilisé au sein d'un des paramètres, l'infrastructure WebPart encode le délimiteur, comme indiqué dans le tableau suivant.
Délimiteur |
Codage |
|---|---|
, |
%2 C |
; |
3 B % |
% |
% 25 |
La valeur de la propriété Connections est stockée que sur un côté (composant WebPart) d'une connexion à moins qu'il s'agit d'une connexion entre pages. Pour les connexions entre pages, la connexion est stockée avec les deux côtés d'une connexion. Par défaut, l'infrastructure WebPart stocke la valeur de la propriété Connections avec le composant WebPart consommateur, bien que l'infrastructure prend en charge le stockage d'une connexion sur le côté fournisseur des composants WebPart statique (un composant WebPart en dehors d'un contrôle WebPartZone ) et pour les connexions entre pages.
Cette propriété ne peut pas être personnalisée par des utilisateurs individuels. La valeur de sa WebPartStorageAttribute est Storage.Shared, qui spécifie que la propriété est enregistrée avec la même valeur pour tous les utilisateurs. Seuls les utilisateurs disposant du droit d'écrire des pages web peuvent définir cette propriété. Il peut être défini uniquement par programme.
Exemples
Voici un exemple d'un paramètre de la propriété Connections pour une connexion directe entre ICellProvider et ICellConsumer composants WebPart sur la même page de composants WebPart.
f690a578-6d1b-4d04-b081-011a93fa23bf,332f8676-875b-44eb-a537-8f946edb7e5f,MyCellConsumer_WPQ_,MyCellProvider_WPQ_,MyCellConsumer_WPQ_,MyCellProvider_WPQ_
Voici un exemple de paramètres de la propriété Connections pour les deux côtés d'une connexion entre pages entre un IFilterConsumer composant WebPart et un IRowProvider WebPart à l'aide d'un transformateur.
Le paramètre de la propriété Connection pour le composant WebPart dans la page source (source ASPX) suit :
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>
Le paramètre de la propriété Connection pour le composant WebPart dans la page cible (cible ASPX) suit :
a93e4d5a-835b-4a80-80c0-a0e23149ed03,69c42cf9-e98b-4f6e-954a-42c7b46ba32e,MyFilterConsumerInterface_WPQ_,RowProviderInterface,MyFilterConsumerInterface_WPQ_,RowProviderInterface,,0e194b89-eaf0-4fcb-93f9-fe6c0a7a88d1,source.aspx,