À propos des composants WebPart

Un composant WebPart est une unité modulaire d'information à but unique qui constitue la base d'une page de composants WebPart. Chaque composant WebPart est constitué de deux fichiers de base, nécessite souvent des fichiers de ressources supplémentaires et ses valeurs de propriété sont stockées dans des tables de bases de données. Comprendre le fonctionnement des composants WebPart peut vous aider à les partager de manières plus créatives et intéressantes et d'éviter des problèmes.

Le schéma suivant résume la structure des composants WebPart en prenant le composant WebPart Image comme exemple.

Présentation de l'architecture du composant WebPart

1 Le fichier de description (.dwp) du composant WebPart Image est un conteneur portable des valeurs de propriété par défaut et personnalisées du composant WebPart Image.

2 Le fichier d'assembly (.dll) du composant WebPart Image renferme la logique et le code du composant ; il est installé sur le serveur du site.

3 Les fichiers de ressources qui prennent en charge le composant WebPart Image sont également stockés sur le serveur du site.

4 Les tables de la base de données Windows SharePoint Services servent à stocker les valeurs actuelles des propriétés du composant WebPart Image.

Les deux concepts suivants sont essentiels pour comprendre comment sont conçus les composants WebPart :

Chaque composant WebPart ne comprend qu'un seul fichier d'assembly, mais votre site peut utiliser plusieurs instances d'un composant (voire même d'autres sites). Chaque instance d'un composant WebPart spécifique, qu'elle ait une apparence et un comportement similaires ou différents, est toujours basée sur le même fichier d'assembly installé sur le serveur du site. Un fichier d'assembly peut également contenir du code pour plusieurs composants WebPart.
Pour qu'un composant WebPart fonctionne correctement, ces deux fichiers et des fichiers de ressources supplémentaires, doivent être présents et accessibles sur votre site. Ceci ne pose pas de problème en ce qui concerne les composants WebPart intégrés dans Microsoft Windows SharePoint Services, mais pourrait en poser un pour les composants WebPart provenant d'un autre site ou d'une autre source.

Le fichier de description du composant WebPart est un fichier texte XML avec l'extension .dwp. Ce fichier contient les éléments suivants :

Les noms de propriétés et les paramètres de cette instance du composant WebPart.
Une référence à son fichier compagnon, le fichier d'assembly (.dll) du composant Web Part.
Si un utilisateur a personnalisé un composant WebPart, les modifications apportées aux paramètres de propriété communs ou personnalisés.

Voici, par exemple, le fichier de description du composant WebPart Image :

<?xml version="1.0" encoding="utf-8"?>
<WebPart xmlns:xsd="http://www.w3.org/2001/XMLSchema"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="http://schemas.microsoft.com/WebPart/v2"> (1)
  <Title>Image Web Part</Title>
  <FrameType>Default</FrameType>
  <Description>Use to display pictures and photos.</Description>
  <IsIncluded>true</IsIncluded>
  <ZoneID>LeftColumn</ZoneID>
  <PartOrder>1</PartOrder>
  <FrameState>Normal</FrameState>
  <Height /> (2)
  <Width />
  <AllowRemove>true</AllowRemove>
  <AllowZoneChange>true</AllowZoneChange>
  <AllowMinimize>true</AllowMinimize>
  <IsVisible>true</IsVisible>
  <DetailLink />
  <HelpLink />
  <Dir>Default</Dir>
  <PartImageSmall />
  <MissingAssembly />
  <PartImageLarge>/_layouts/images/msimagel.gif</PartImageLarge> (3)
  <IsIncludedFilter />
  <Assembly>Microsoft.SharePoint, Version=11.0.0.0, Culture=neutral, 
     PublicKeyToken=71e9bce111e9429c</Assembly>
</WebPart> (1)

1 L'élément du composant WebPart identifie ce code XML en tant que fichier de description du composant WebPart et contient les autres éléments du fichier.

2 Si la valeur de propriété n'est pas renseignée, le composant WebPart utilise les valeurs par défaut stockées dans les tables de la base de données.

3 Si la valeur de propriété est renseignée, le composant WebPart remplace la valeur par défaut et utilise la nouvelle valeur de cette instance du composant.

Lorsque vous installez Windows SharePoint Services pour la première fois, un fichier de description du composant WebPart est généralement stocké dans la galerie de composants WebPart du site. Au fil du temps, d'autres instances de ce fichier de description sont créées, au fur et à mesure que les utilisateurs exportent des composants WebPart et que les administrateurs du site chargent et téléchargent des composants WebPart.

Le fichier d'assembly du composant WebPart est un fichier de bibliothèque de liaison dynamique (Dynamic Link Library, .dll) ASP.NET qui contient la logique et le code du composant WebPart. Il s'agit du fichier compagnon du fichier de description du composant WebPart. Chaque instance d'un composant WebPart sur un site compte un seul et unique fichier d'assembly. Ce fichier contient le code géré dérivé d'un contrôle de formulaire Web ASP.NET (def). Le code géré est essentiel au fonctionnement des composants WebPart étant donné que les pages de composants WebPart sont en fait des pages Web ASP.NET (.aspx).

Lors de l'installation de Windows SharePoint Services, le fichier d'assembly de chaque composant WebPart est installé sur le serveur du site. Au fil du temps, l'administrateur du site peut installer des composants WebPart personnalisés supplémentaires. Les fichiers de ressources dont le composant WebPart a besoin (images, fichiers de langues et autres fichiers auxiliaires) sont également installés dans les dossiers système sur le serveur du site. Pour garantir qu'un composant WebPart est sûr, il doit être enregistré par l'administrateur du site comme contrôle fiable.

Chaque composant WebPart partage un ensemble de propriétés communes (également appelées propriétés de classe de base) organisées en sections dans le volet d'outils qui contrôle son apparence (titre, hauteur et largeur), sa disposition (agencement du composant WebPart dans la zone et direction du contenu), ainsi que des caractéristiques avancées (icône d'image et description).

De nombreux composants WebPart ont également des propriétés personnalisées uniques. Ces propriétés apparaissent généralement au-dessus ou en dessous des propriétés communes du composant, dans le volet d'outils. Le composant WebPart Image, par exemple, a des propriétés supplémentaires personnalisées, parmi lesquelles un lien d'image, son alignement horizontal et vertical ainsi qu'une couleur d'arrière-plan.

Remarque Suivant la manière dont le composant WebPart a été créé, il peut arriver qu'une propriété personnalisée apparaisse par défaut dans une section Divers, sous les propriétés communes, dans le volet d'outils.

Chaque instance d'un composant WebPart peut être classée dans un des trois types suivants :

Composant WebPart partagé Composant ajouté à une page de composants WebPart par un utilisateur qui crée ou modifie une page de composants en mode Affichage partagé. Les composants WebPart partagés sont accessibles à tous les utilisateurs d'une page de composants disposant de l'autorisation requise.

Composant WebPart personnalisé Composant WebPart dont une ou plusieurs valeurs de propriété est modifiée par un utilisateur en mode Affichage personnel. Les modifications effectuées sur le composant WebPart personnalisé ne sont visibles et utilisables que par l'utilisateur qui en est l'auteur. Les autres utilisateurs qui n'ont pas effectué de modifications en mode Affichage personnel continuent néanmoins à voir le composant WebPart partagé.

Composant WebPart privé Composant ajouté à une page de composants WebPart par un utilisateur à partir d'une galerie de composants WebPart ou importé d'un ordinateur lors de la création de la modification de la page de composants en mode Affichage personnel. Un composant WebPart privé est exclusivement accessible à l'utilisateur qui l'a ajouté ou importé. Aucun autre utilisateur ne peut voir les composants WebPart privés.

Le type de composant WebPart que vous utilisez peut avoir son importance pour les raisons suivantes :

Vous pouvez être autorisé à modifier uniquement certains types de composants WebPart dans des pages de composants données, mais pas dans d'autres.
Vous pouvez être autorisé à vous connecter à certains types de composants WebPart dans une page de composants WebPart, mais pas à d'autres types de composants de la même page.

L'architecture du composant WebPart comporte de nombreux avantages, ainsi que la séparation des instances des fichiers de description (.dwp) du fichier d'assembly (.dll) du composant WebPart.

Partageabilité Les utilisateurs peuvent facilement personnaliser les composants WebPart sans affecter les instances du même composant WebPart des autres utilisateurs. Les utilisateurs et les administrateurs de site peuvent facilement partager des instances de composants WebPart, soit en envoyant le fichier de description du composant WebPart par courrier électronique, soit en transférant les composants WebPart dans d'autres galeries de site.

Transportabilité Un des principaux avantages du fichier de description du composant WebPart est d'être petit et dès lors facile à transporter et à dupliquer. Lorsque vous exportez, importez, chargez ou téléchargez un composant WebPart, c'est en fait le fichier de description du composant WebPart que vous manipulez.

Performance Le fichier d'assembly du composant WebPart est un code compilé qui accélère l'exécution de la page de composants WebPart. La page de composants WebPart ne doit pas interpréter un code et une logique complexes. Étant donné qu'il n'y a qu'un seul fichier à installer, les administrateurs de site disposent de méthodes simples pour « accélérer » et contrôler un ou plusieurs composants WebPart pour s'assurer qu'aucun utilisateur ou page de composants WebPart ne consomme trop de ressources système.

Évolutivité Les propriétés des composants WebPart étant stockées dans des tables de base de données, de nombreux utilisateurs peuvent partager des composants WebPart et créer un grand nombre d'instances de ces composants sans altérer la performance globale du système. Vous pouvez en outre équilibrer la charge de travail ou rationaliser l'installation des composants WebPart en développant un fichier de package (.cab) du composant et en déployant des composants dans une galerie de composants WebPart du serveur virtuel.

Sécurité Les droits standard et les groupes de sites que propose Microsoft Windows SharePoint Services permettent aux administrateurs de site de contrôler les utilisateurs autorisés à accéder à une page de composants WebPart, afficher ou modifier des données du composant WebPart Affichage de liste, personnaliser la page de composants WebPart, ajouter ou supprimer des composants ou encore modifier les propriétés de composants. Les administrateurs de site peuvent également contrôler les composants WebPart installés sur un site et s'ils peuvent ou non être exécutés sur ce site.

Maintenance Les administrateurs de site peuvent facilement contrôler les composants WebPart exécutés sur un site en contrôlant l'installation du fichier d'assembly du composant WebPart. De plus, si un composant WebPart nécessite des modifications ou si une nouvelle version dotée de nouvelles fonctionnalités est disponible, il leur suffit d'installer le nouveau fichier d'assembly et les éventuels nouveaux fichiers de ressources pour toutes les instances du composant WebPart pour voir les modifications et les nouvelles fonctionnalités.

Les composants WebPart sont conçus pour être faciles à exporter, transporter et importer. Lorsque vous personnalisez un composant WebPart ou qu'un administrateur de site modifie une page de composants WebPart pour tous les utilisateurs, vous (ou l'administrateur du site) pouvez le partager avec d'autres utilisateurs sur votre site ou même un autre site. Par exemple :

Vous pouvez exporter le composant à partir d'une page de composants WebPart avant d'envoyer le ficher de description (.dwp) du composant WebPart par courrier électronique aux autres utilisateurs. Les autres utilisateurs peuvent alors importer le composant dans une page de composants WebPart. Sinon, un administrateur de site peut télécharger le composant directement à partir d'une galerie de composants WebPart pour que tous les utilisateurs puissent y accéder.
Un administrateur de site peut exporter un composant à partir d'une galerie de composants WebPart et ensuite enregistrer le fichier à un emplacement public. Les autres utilisateurs peuvent ensuite importer le composant dans une page de composants WebPart. Sinon, un autre administrateur de site peut charger le fichier de description du composant WebPart dans une autre galerie de composants WebPart de site.

Dans tous les cas, il est important de s'assurer que le fichier d'assembly du composant WebPart est également installé sur le nouveau site pour que le nouveau composant que vous avez créé puisse être exécuté sur ce site.

Remarque Vous ne pouvez pas exporter un composant WebPart Affichage de liste. Les listes sont, en effet, spécifiques à un site et ne peuvent être transportées vers d'autres sites de la même manière que les autres composants WebPart. Pour déplacer des données de liste d'un site vers un autre, vous devez les exporter du site et les importer dans une liste sur l'autre site où un composant WebPart Affichage de liste est automatiquement ajouté pour les nouvelles données de liste dans la galerie de composants WebPart de l'autre site.