Créer des composants WebPart pour SharePoint

  • Article

Les composants WebPart vous permettent de modifier le contenu, l’apparence et le comportement des pages d’un site SharePoint à l’aide d’un navigateur. Les composants WebPart sont des contrôles côté serveur qui s’exécutent à l’intérieur d’une page de composant WebPart : il s’agit des blocs de construction des pages qui apparaissent sur un site SharePoint. Consultez Bloc de construction : composants WebPart.

Vous pouvez créer et déboguer des composants WebPart sur un site SharePoint à l’aide de modèles de Visual Studio.

Créer un composant WebPart dans Visual Studio

Créez un composant WebPart en ajoutant un élément de composant WebPart à n’importe quel projet SharePoint. Vous pouvez utiliser un élément de composant WebPart dans une solution bac à sable ou une solution de batterie de serveurs.

Si vous souhaitez concevoir visuellement un composant WebPart à l’aide d’un concepteur, créez un projet de composant Visual WebPart ou ajoutez un élément de composant Visual WebPart à n’importe quel projet SharePoint. Vous pouvez utiliser un élément de composant Visual Recherche WebWebPart dans une solution de batterie de serveurs uniquement.

Élément de composant WebPart

Un élément de composant WebPart fournit des fichiers que vous pouvez utiliser pour concevoir un composant WebPart pour un site SharePoint. Lorsque vous ajoutez un élément de composant WebPart, Visual Studio crée un dossier dans votre projet, puis ajoute plusieurs fichiers au dossier. Le tableau suivant décrit chaque fichier.

Fichier Description
Elements.xml Contient les informations que le fichier de définition des fonctionnalités de votre projet utilise pour déployer le composant WebPart.
Fichier .webpart Fournit les informations dont SharePoint a besoin pour afficher votre composant WebPart dans une galerie de composants WebPart.
Fichier de code Contient des méthodes qui ajoutent des contrôles au composant WebPart et qui génèrent du contenu personnalisé dans le composant WebPart.

Pour plus d’informations, consultez Guide pratique pour créer un composant WebPart SharePoint.

Composant Visual WebPart

Un composant Visual WebPart est un composant WebPart que vous créez à l’aide du concepteur Visual Web Developer dans Visual Studio. Un composant Visual WebPart fonctionne comme n’importe quel autre composant WebPart. Pour ajouter des contrôles, tels que des boutons et des zones de texte, à un composant WebPart, vous ajoutez du code à un fichier XML. Toutefois, vous ajoutez des contrôles à un composant Visual WebPart en les faisant glisser ou en les copiant sur le composant WebPart à partir de la boîte à outils Visual Studio. Le concepteur génère ensuite le code requis dans le fichier XML. Consultez Guide pratique pour créer un composant WebPart SharePoint à l’aide d’un concepteur.

Contrôles SharePoint

Visual Studio fournit certains contrôles pour la création de pages SharePoint, comme les pages d’application. Ces contrôles s’affichent dans la boîte à outils sous Contrôles SharePoint. La fonctionnalité de ces contrôles dérive de l’espace de noms Microsoft.SharePoint.WebControls, qui contient les contrôles serveur ASP.NET utilisés sur les pages de site et de liste SharePoint.

Nom du contrôle Description
AspMenu Insère un menu ASP. Pour plus d’informations, consultez Vue d’ensemble du contrôle de menu.
CssLink Insère un élément LINK dans la page .aspx et applique une ou plusieurs feuilles de style externes définies par CssRegistration.
DateTimeControl Insère un contrôle DateTime dans la page .aspx .
FormDigest Insère une validation de sécurité dans la page .aspx
ListProperty Retourne une propriété d’une liste spécifiée.
ProjectProperty Retourne une propriété globale du site web actuel.
RssLink Insère un lien vers un flux RSS dans la page .aspx .
ScriptLink Fournit des propriétés et des méthodes pour inscrire des ressources, telles que des scripts, sur une page afin qu’elles puissent être demandées lors du rendu de la page.
Thème Applique un thème à la page .aspx .

Déboguer un composant WebPart

Vous pouvez déboguer un projet SharePoint qui contient un composant WebPart comme vous le feriez pour d’autres projets Visual Studio. Lorsque vous démarrez le débogueur Visual Studio, Visual Studio ouvre le site SharePoint.

Pour commencer à déboguer votre code, ajoutez le composant WebPart à une page de composant WebPart dans SharePoint.

Pour plus d’informations sur le débogage de projets SharePoint, consultez Résoudre les problèmes liés aux solutions SharePoint.

Limitations des composants Visual Web Part

À partir de Visual Studio, vous pouvez ajouter des composants Visual WebPart aux solutions SharePoint en bac à sable et aux solutions de batterie de serveurs. Toutefois, les composants Visual WebPart présentent les limitations suivantes :

  • Les composants Visual WebPart ne prennent pas en charge les paramètres remplaçables. Pour plus d’informations, consultez Paramètres remplaçables.

  • Les contrôles utilisateur ou les composants Visual WebPart ne peuvent pas être glissés et déposés ou copiés sur des composants Visual WebPart. Cette action provoque une erreur de build.

  • Les composants Visual WebPart ne prennent pas directement en charge les jetons de serveur SharePoint tels que les $SPUrl. Pour plus d’informations, consultez « Restrictions de jetons dans les composants Visual WebPart en bac à sable » dans la rubrique Résoudre les problèmes liés aux solutions SharePoint.

  • Les composants Visual WebPart d’une solution bac à sable obtiennent parfois l’erreur suivante : « La demande d’exécution de code bac à sable a été refusée, car le service hôte de code bac à sable était trop occupé pour gérer la demande. » Pour plus d’informations sur cette erreur, consultez ce billet dans le blog de l’équipe de développement SharePoint.

  • Le débogage JavaScript côté serveur n’est pas pris en charge dans Visual Studio, mais le débogage JavaScript côté client est pris en charge.

    Bien que vous puissiez ajouter JavaScript inline à un fichier de balisage côté serveur, le débogage n’est pas pris en charge pour les points d’arrêt ajoutés au balisage. Pour déboguer JavaScript, référencez un fichier JavaScript externe dans le fichier de balisage, puis définissez les points d’arrêt dans le fichier JavaScript.

  • Le débogage du code inline ASP.NET doit être effectué dans le fichier de code généré plutôt que dans le fichier de balisage.

  • Les composants Visual WebPart ne prennent pas en charge l’utilisation de la directive <@ Assembly Src=.

  • Les contrôles web SharePoint et certains contrôles ASP.NET ne sont pas pris en charge dans l’environnement de bac à sable SharePoint. Si des contrôles non pris en charge sont utilisés sur un composant Visual WebPart dans une solution bac à sable (sandbox), l’erreur « Le type ou le nom d’espace de noms ’Theme’ n’existe pas dans l’espace de noms ’Microsoft.SharePoint.WebControls’ » s’affiche.

    Pour plus d’informations sur les solutions bac à sable, consultez Différences entre les solutions bac à sable et les solutions de batterie de serveurs.

Créer des composants WebPart basés sur SharePoint de style plus ancien

Vous pouvez utiliser les modèles dans Visual Studio pour créer des composants WebPart ASP.NET 2.0 personnalisés pour SharePoint. Les composants WebPart ASP.NET 2.0 sont basés sur l’infrastructure de composant WebPart ASP.NET et sont le type recommandé pour les nouveaux projets.

Dans de très rares cas, vous devrez peut-être créer un composant WebPart à l’aide du composant WebPart SharePoint de style plus ancien. Vous pouvez utiliser Visual Studio pour créer ces types de composants WebPart, mais Visual Studio ne fournit pas de modèles conçus spécifiquement pour vous aider à les créer.

Pour plus d’informations sur le moment où vous souhaitez créer un composant WebPart de style ancien basé sur SharePoint, consultez Infrastructure de composant WebPart dans Windows SharePoint Services. Pour plus d’informations sur la création d’un composant WebPart à l’aide du composant WebPart SharePoint de style plus ancien, consultez Procédure pas-à-pas de création d’un composant WebPart SharePoint de base.

Intitulé Description
Guide pratique pour créer un composant WebPart SharePoint Montre comment créer des composants WebPart pour les pages SharePoint.
Guide pratique pour créer un composant WebPart SharePoint à l’aide d’un concepteur Montre comment créer des composants WebPart pour SharePoint à l’aide d’une surface de conception visuelle.
Guide pratique pour créer un contrôle utilisateur pour un composant WebPart ou une page d’application SharePoint Vous montre comment créer des contrôles utilisateur personnalisés et réutilisables pouvant être consommés par les pages d’application et les composants WebPart qui s’exécutent dans SharePoint.
Procédure pas-à-pas : créer un composant WebPart pour SharePoint Décrit comment concevoir un composant WebPart pour SharePoint.
Procédure pas-à-pas : créer un composant WebPart pour SharePoint à l’aide d’un concepteur Décrit comment concevoir un composant WebPart pour SharePoint en faisant glisser des contrôles vers une surface de conception visuelle.
Procédure pas-à-pas : créer un composant WebPart Silverlight qui affiche OData pour SharePoint Décrit comment concevoir un composant WebPart pour SharePoint qui héberge une application Silverlight et affiche les données des listes SharePoint.