Procédure pas à pas : création d'un composant WebPart de base

Article
09/24/2014

Dernière modification : jeudi 1 septembre 2011

S’applique à : SharePoint Foundation 2010

Dans cet article
Créer un composant WebPart
Ajouter une propriété de composant WebPart
Substituer la méthode Render
Déployer et tester le composant WebPart

Cette procédure pas à pas présente les étapes permettant de créer un composant WebPart personnalisé de base qui peut être ajouté à vos pages de site. Ce composant WebPart simple permet à l’utilisateur de définir un message personnalisé à afficher dans celui-ci. Il dérivera de la classe WebPart Microsoft ASP.NET, méthode recommandée pour SharePoint Foundation.

Pour plus d’informations sur les composants WebPart ASP.NET, voir les sites suivants consacrés à ASP.NET : Didacticiels de démarrage rapide ASP.NET (éventuellement en anglais) et Contrôles WebPart ASP.NET.

Conditions requises

ASP.NET

Outils de développement SharePoint dans Microsoft Visual Studio 2010

Créer un composant WebPart

Pour créer un composant WebPart

Démarrez Outils de développement SharePoint dans Visual Studio 2010.
Dans le menu Fichier, pointez sur Nouveau, puis cliquez sur Projet.
Dans Types de projets, sous Visual Basic ou C#, sélectionnez Projet SharePoint vide.
Tapez Sample.DisplayMessage comme nom de projet. Cliquez sur OK.
Dans l’Assistant Personnalisation de SharePoint, choisissez Déployer en tant que solution bac à sable (sandbox). Cliquez sur Terminer.
Dans l’Explorateur de solutions, cliquez avec le bouton droit sur le projet Sample.DisplayMessage, puis sélectionnez Ajouter et Nouvel élément.
Dans la boîte de dialogue Ajouter un nouvel élément, sélectionnez le modèle Composant WebPart et tapez DisplayMessageWebPart dans la zone Nom. Cliquez sur Ajouter.

Ajouter une propriété de composant WebPart

Après avoir ajouté le nouveau composant WebPart, ajoutez une propriété pouvant être personnalisée pour celui-ci. La propriété du composant WebPart détermine le texte à afficher dans le composant WebPart. Elle est personnalisée en fonction de l’utilisateur.

Notes

Pour plus d'informations sur la personnalisation, voir Personnalisation des WebParts.

Pour les composants WebPart basés sur la classe de base Pages WebPart ASP.NET, les balises utilisées pour les propriétés personnalisables sont différentes de celles utilisées pour les composants WebPart basés sur la classe de base WebPart. La liste suivante décrit chacune de ces propriétés :

L’attribut WebBrowsableAttribute s’assure que la propriété personnalisée s’affiche dans le volet des outils d’édition de SharePoint Foundation.
L’attribut WebDescriptionAttribute affiche une info-bulle qui guide les utilisateurs lors de la modification de votre propriété personnalisée.
L’attribut WebDisplayNameAttribute affiche un nom complet pour votre propriété personnalisée.
L’attribut PersonalizableAttribute détermine si les modifications de votre propriété personnalisée affectent tous les utilisateurs ou des utilisateurs spécifiques.

Créer la propriété du composant WebPart

Dans le fichier DisplayMessageWebPart, copiez et collez le code ci-après pour créer une propriété personnalisable de base.

private string customMessage = "Hello, world!";

public string DisplayMessage
{
    get { return customMessage; }
    set { customMessage = value; }
}

Private customMessage As String = "Hello, world!"

Public Property DisplayMessage() as String
    Get
        Return customMessage
    End Get
    Set(ByVal value as String)
        customMessage = value
    End Set
End Property

Ajoutez ensuite les balises suivantes au-dessus de la déclaration publique pour autoriser les modifications par utilisateur :

[WebBrowsable(true),
WebDescription("Displays a custom message"),
WebDisplayName("Display Message"),
Personalizable(PersonalizationScope.User)]

<WebBrowsable(True), _
WebDescription("Displays a custom message"), _
WebDisplayName("Display Message"), _
Personalizable(PersonalizationScope.User)> _

Vous venez de créer une propriété de composant WebPart personnalisable.

Substituer la méthode Render

Vous devez à présent ajouter des fonctionnalités à votre composant WebPart. En substituant la méthode Control.Render, vous pouvez indiquer au composant WebPart les opérations à effectuer lors de la visite de la page. Dans cet exemple, le composant WebPart affichera le texte défini par l'utilisateur.

Pour substituer la méthode Render

Dans le fichier DisplayMessageWebPart, copiez et collez le code ci-après pour substituer la méthode Render.

protected override void Render(System.Web.UI.HtmlTextWriter writer)
{
    writer.Write(DisplayMessage);
}

Protected Overrides Sub Render(ByVal writer As System.Web.UI.HtmlTextWriter)
    writer.Write(DisplayMessage)
End Sub

Déployer et tester le composant WebPart

Pour déployer et tester le composant WebPart

Appuyez sur la touche F5 pour déployer le composant WebPart.
Une fois la page ouverte dans le navigateur, cliquez sur le bouton Modifier sous l’onglet Page pour placer la page en mode édition.
Sous l’onglet Insertion du groupe contextuel Outils d’édition, cliquez sur le bouton Composant WebPart.
Dans la liste Catégories, choisissez Personnalisé, puis choisissez DisplayMessageWebPart dans la liste Composants WebPart. Cliquez sur Ajouter. Le composant WebPart apparaît dans la page et affiche le texte Hello, world!.
Pour modifier le texte affiché sur le composant WebPart, sélectionnez celui-ci dans la page, ouvrez l’onglet Options dans le groupe contextuel Outils de composant WebPart, puis cliquez sur le bouton Propriétés du composant WebPart.
Dans le volet des propriétés DisplayMessageWebPart, développez la catégorie Divers, puis modifiez la valeur Display Message. Cliquez ensuite sur Appliquer.
Le composant WebPart affiche désormais la valeur définie par l'utilisateur.

Partager via