Création de contrôles réutilisables pour les composants WebPart ou les pages d'application

Article
08/10/2011

Visual Studio vous permet de créer des contrôles personnalisés et réutilisables qui peuvent être consommés par des pages d'application et des composants WebPart qui s'exécutent dans SharePoint. Ces contrôles sont appelés contrôles utilisateur. Pour plus d'informations sur les contrôles utilisateur, consultez Contrôles utilisateur ASP.NET.

Création d'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 Comment : 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 du contrôle utilisateur	Définit le contrôle utilisateur. Vous pouvez concevoir le contrôle utilisateur en ajoutant des contrôles et du balisage à ce fichier.
Fichier de code	Contient le code-behind du contrôle utilisateur. Vous pouvez ajouter du code à ce fichier pour gérer des événements.
Fichier de code du concepteur	Contient le code généré par le concepteur. Ne doit pas être modifié directement.

Conception du contrôle utilisateur

Vous pouvez concevoir le contrôle utilisateur à l'aide du concepteur Visual Web Developer dans Visual Studio. Ce concepteur s'affiche lorsque vous double-cliquez sur le fichier du contrôle utilisateur dans votre projet. Pour plus d'informations sur l'utilisation de ce concepteur, consultez Organigramme des informations relatives à Visual Web Developer.

Consommation du contrôle utilisateur

Les contrôles utilisateur ne s'affichent pas dans SharePoint tant que vous ne les avez pas inclus dans une page d'application ou un composant WebPart.

Pour inclure un contrôle utilisateur dans une page d'application, ajoutez une directive @ Register à la page d'application, puis déclarez le contrôle utilisateur dans un ou plusieurs espaces réservés de contenu dans la page. Pour obtenir un exemple de réalisation de cette tâche dans une page Web ASP.NET standard, consultez Comment : inclure un contrôle utilisateur dans une page Web ASP.NET.

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

<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

[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);
    }

}

Débogage d'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 le code dans le contrôle utilisateur de la même manière que vous le feriez dans tout 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 Dépannage des solutions SharePoint.

Rubriques connexes

Titre	Description
Comment : créer un contrôle utilisateur pour un composant WebPart ou une page d'application SharePoint	Explique comment créer des contrôles personnalisés et réutilisables qui peuvent être utilisés par des pages d'application et des composants WebPart s'exécutant dans SharePoint.
Utilisation de Visual Web Developer	Explique comment utiliser le concepteur qui s'affiche à l'ouverture d'une page Web dans votre projet.

Partager via