Créer des contrôles réutilisables pour des composants WebPart ou des pages d’application

Dans Visual Studio, vous pouvez 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. Ces contrôles sont appelés contrôles utilisateur. Un contrôle utilisateur est une sorte de contrôle composite qui fonctionne comme une page web ASP.NET : vous pouvez ajouter des contrôles de serveur web existants et le balisage à un contrôle utilisateur, et définir des propriétés et des méthodes pour le contrôle. Vous pouvez ensuite les incorporer dans des pages web ASP.NET, où elles agissent en tant qu’unité.

Créer un contrôle utilisateur

Pour créer un contrôle utilisateur, ajoutez un Contrôle utilisateur à un Projet SharePoint vide. Pour plus d’informations, consultez Guide pratique pour créer un contrôle utilisateur pour un composant WebPart ou une page d’application SharePoint.

Lorsque vous ajoutez un élément Contrôle utilisateur, Visual Studio crée un dossier dans votre projet, puis ajoute plusieurs fichiers au dossier. Le tableau suivant décrit chaque fichier.

Fichier	Description
Fichier de contrôle utilisateur	Définit le contrôle utilisateur. Concevez le contrôle utilisateur en ajoutant des contrôles et du balisage à ce fichier.
Fichier de code	Contient le code derrière le contrôle utilisateur. Ajoutez à ce fichier du code pour gérer les événements.
Fichier de code du concepteur	Contient le code généré par le Concepteur et ne doit pas être modifié directement.

Concevoir le contrôle utilisateur

Concevez le contrôle utilisateur à l’aide du concepteur Visual Web Developer dans Visual Studio. Ce concepteur s’affiche lorsque vous ouvrez le fichier de contrôle utilisateur dans votre projet et que vous choisissez l’onglet Conception.

Consommer le contrôle utilisateur

Les contrôles utilisateur n’apparaissent pas dans SharePoint tant que vous ne les incluez pas dans une page d’application ou un composant WebPart.

Pour inclure un contrôle utilisateur dans une page d’application, ouvrez la page web à laquelle vous souhaitez ajouter le contrôle utilisateur ASP.NET. Basculez en mode Création, puis sélectionnez votre fichier de contrôle utilisateur personnalisé dans l’Explorateur de solutions, et faites-le glisser sur la page. Le contrôle utilisateur ASP.NET est ajouté à la page, et le concepteur crée la directive @ Register, qui est nécessaire pour que la page reconnaisse le contrôle utilisateur. Vous pouvez maintenant utiliser les propriétés et méthodes publiques du contrôle.

Pour inclure un contrôle utilisateur dans un composant WebPart, ajoutez le contrôle utilisateur à la collection de composants WebPart Controls dans le fichier de code du composant WebPart. L’exemple suivant ajoute un contrôle utilisateur à la collection Controls d’un composant WebPart.

C#

[ToolboxItemAttribute(false)]
public class VisualWebPart1 : WebPart
{
    private const string _ascxPath = @"~/_CONTROLTEMPLATES/CS/VisualWebPart1/VisualWebPart1UserControl.ascx";

    public VisualWebPart1()
    {
    }

    protected override void CreateChildControls()
    {
        Control control = this.Page.LoadControl(_ascxPath);
        Controls.Add(control);
        base.CreateChildControls();
    }

    protected override void RenderContents(HtmlTextWriter writer)
    {
        base.RenderContents(writer);
    }
    
}

VB

<ToolboxItemAttribute(false)> _
Public Class VisualWebPart1
    Inherits WebPart

    Private Const _ascxPath As String = "~/_CONTROLTEMPLATES/VB/VisualWebPart1/VisualWebPart1UserControl.ascx"

    Public Sub New()
    End Sub

    Protected Overrides Sub CreateChildControls()
        Dim control As Control = Page.LoadControl(_ascxPath)
        Controls.Add(control)
        MyBase.CreateChildControls()
    End Sub

    Protected Overrides Sub RenderContents(ByVal writer As HtmlTextWriter)
        MyBase.RenderContents(writer)
    End Sub

End Class

Déboguer un contrôle utilisateur

Pour déboguer un contrôle utilisateur, vérifiez que le contrôle utilisateur est inclus dans une page d’application ou un composant WebPart dans votre projet SharePoint. Vous pouvez ensuite déboguer du code dans le contrôle utilisateur comme vous le feriez dans n’importe quel projet Visual Studio.

Lorsque vous démarrez le débogueur Visual Studio, Visual Studio ouvre le site SharePoint.

Dans SharePoint, ouvrez la page d’application qui inclut le contrôle utilisateur. Si le contrôle utilisateur est inclus dans un composant WebPart, 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.

Rubriques connexes

Intitulé	Description
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.