FAQ ASP.NET/VB.NET

Sommaire > Les contr�les utilisateurs
        Comment cr�er un contr�le utilisateur (User Control .ascx) ?
        Comment utiliser un contr�le utilisateur dans une page ?
        J'ajoute un contr�le dans mon user control et le compilateur ne le reconnait pas dans le code behind ?
        Je cr�e mon user control dynamiquement mais je n'arrive pas � acceder aux champs qu'il contient (null) ?
        Comment passer des param�tres � un userControl ?
        Comment passer des param�tres au constructeur d'un contr�le utilisateur ?
        Comment d�clarer mon contr�le utilisateur pour qu'il soit d�clar� dans toutes mes pages ?

� Version hors-ligne (Miroir)

Comment cr�er un contr�le utilisateur (User Control .ascx) ?

[haut]

auteur : nico-pyright(c)

Un contr�le utilisateur (extension .ascx) est grosso modo une mini page (.aspx) qui peut s'inclure dans une page et qui ne comporte aucune des balises suivantes : <html><body><form>.
Un contr�le utilisateur a pour directive :


					<%@ Control Language="C#" AutoEventWireup="false" CodeBehind="monUserControl.ascx.cs" Inherits="monProjet.monUserControl" %>

Pour l'ajouter depuis visual studio :
Click droit sur le projet, Add --> New Item -> Web User Control

L'IDE g�n�re automatiquement la directive du contr�le utilisateur et le fichier source de code behind dont devra h�riter le contr�le utilisateur.
NB : penser � mettre AutoEventWireup � false (voir A quoi sert AutoEventWireup ?)

Comment utiliser un contr�le utilisateur dans une page ?

[haut]

auteur : nico-pyright(c)

Pour utiliser un contr�le utilisateur dans sa page, il faut utiliser la directive @register pour faire connaitre le contr�le utilisateur � la page :


					<%@ Register Src="~/monUserControl.ascx" TagName="MonUserControl" TagPrefix="UC" %>

(NB : on peut pr�ciser l'assembly qui contient l'userControl si celle-ci est diff�rente en rajoutant l'attribut Assembly="....")
Pour l'ins�rer enfin dans sa page, on utilisera la combinaison TagPrefix:TagName :

<UC:MonUserControl runat="server" />

Cette derni�re ligne de code devra bien sur �tre ajout�e entre les balises <form> et </form> de sa page.

J'ajoute un contr�le dans mon user control et le compilateur ne le reconnait pas dans le code behind ?

[haut]

auteur : nico-pyright(c)

Lorsque j'ajoute un contr�le (label) par exemple :



					<asp:Label ID="monLabel" Text="Mon text" runat="server" />

L'IDE ajoute automatiquement dans la classe partielle (fichier .designer.cs)


					Protected WithEvents monLabel As System.Web.UI.WebControls.Label

Il peut arriver que l'ide n'arrive pas � ajouter ce membre en protected (source control qui bloque le fichier, lecture seule, etc ...)
Dans ce cas, il faudra le rajouter � la main dans ce m�me fichier
V�rifiez �galement qu'il ne soit pas d�clar� en private.

Je cr�e mon user control dynamiquement mais je n'arrive pas � acceder aux champs qu'il contient (null) ?

[haut]

auteur : nico-pyright(c)

Lorsque vous essayez d'acc�der aux contr�les pr�sents dans votre user control, vous obtenez l'exception : System.NullReferenceException
C'est que vous avez probablement cherch� � instancier votre usercontrol avec new, de cette facon par exemple :


					Dim uc As New monUserControl
monPlaceHolder.Controls.Add(uc)

Ce n'est pas la bonne m�thode.
Pour charger un UserControl, il faut utiliser LoadControl. La m�thode LoadControl lit le fichier et l'instancie comme un contr�le pouvant �tre ajout� � la page.


					Dim uc As monUserControl = CType(LoadControl("~/monUserControl.ascx"), monUserControl)
monPlaceHolder.Controls.Add(uc)

Remarque : En g�n�ral, il vaut mieux �viter de charger un contr�le utilisateur dynamiquement ; il vaudra mieux le placer dans la page aspx (ou un usercontrol ascx) quitte � le masquer dans le OnInit si on en a pas besoin suivant certaines conditions

Comment passer des param�tres � un userControl ?

[haut]

auteur : nico-pyright(c)

La solution la plus classique est de cr�er des propri�t�s publiques sur ce contr�le utilisateur et de les renseigner lors de l'ajout du contr�le utilisateur dans la page.
Source du contr�le utilisateur :


					Public Partial Class monUserControl
    Inherits System.Web.UI.UserControl

    Private _maValeur As String
    Public Property MaValeur() As String
        Get
            Return _maValeur
        End Get
        Set(ByVal value As String)
            _maValeur = value
        End Set
    End Property

    Protected Overrides Sub OnLoad(ByVal e As System.EventArgs)
        monLabel.Text = _maValeur
        MyBase.OnLoad(e)
    End Sub
End Class

dans la page.aspx


					
<UC:MonUserControl runat="server" MaValeur="une valeur" />

NB : cet exemple initialise la propri�t� MaValeur � un label dans le onInit. Il aurait pu �tre judicieux �videment d'utiliser un databinding avec # (voir Qu'est-ce que le scriptlet d'expressions li�es <%# expression %>?)
voir aussi : comment passer des param�tres au constructeur d'un contr�le utilisateur

Comment passer des param�tres au constructeur d'un contr�le utilisateur ?

[haut]

auteur : nico-pyright(c)

On peut �tre tent� lors du chargement dynamique d'un contr�le utilisateur d'utiliser un constructeur qui a des param�tres au lieu de cr�er des propri�t�s et de les renseigner.
Prenons ce contr�le utilisateur par exemple :


					Public Partial Class monUserControl
    Inherits System.Web.UI.UserControl

    Private _maValeur As String

    Public Sub New()
    End Sub
    Public Sub New(ByVal maValeur As String)
        _maValeur = maValeur
    End Sub

    Protected Overrides Sub OnLoad(ByVal e As System.EventArgs)
        If (String.IsNullOrEmpty(_maValeur)) Then
            monLabel.Text = "Valeur par d�faut"
        Else
            monLabel.Text = _maValeur
        End If
        MyBase.OnLoad(e)
    End Sub
End Class

Si on charge ce contr�le utilisateur sans passer de param�tres au constructeur, on aura une valeur par d�faut ; sinon on utilisera la valeur pass�e.
On a bien not� qu'il fallait utiliser LoadControl lors d'un chargement dynamique de contr�le utilisateur (voir Je cr�e mon user control dynamiquement mais je n'arrive pas � acceder aux champs qu'il contient (null) ?)
Voici une fonction statique qui s'occupe d'instancier le contr�le utilisateur avec des param�tres dans le constructeur, en utilisant la reflexion


					Public Shared Function LoadControl(ByVal page As Page, ByVal pathControleUtilisateur As String, ByVal ParamArray parametresConstructeur As String()) As UserControl
        Dim constParamTypes As New List(Of Type)
        For Each constParam As Object In parametresConstructeur
            constParamTypes.Add(constParam.GetType())
        Next
        Dim uc As UserControl = CType(page.LoadControl(pathControleUtilisateur), UserControl)
        ' trouve le constructeur
        Dim constructeur As ConstructorInfo = uc.GetType().BaseType.GetConstructor(constParamTypes.ToArray())
        ' et l'invoke
        If (constructeur Is Nothing) Then
            Throw New MemberAccessException("Contr�le utilisateur non trouv� : " + uc.GetType().BaseType.ToString())
        Else
            constructeur.Invoke(uc, parametresConstructeur)
        End If
        Return uc
    End Function

A utiliser ainsi :


					Dim uc As monUserControl = CType(LoadControl(Page, "~/monUserControl.ascx", "Ma valeur pass�e"), monUserControl)
monPlaceHolder.Controls.Add(uc)

NB : ne pas oublier de cr�er �galement un constructeur par d�faut, sinon vous aurez l'erreur suivante


					CS1501: Aucune surcharge pour la m�thode 'monUserControl' ne prend d'arguments '0'

Comment d�clarer mon contr�le utilisateur pour qu'il soit d�clar� dans toutes mes pages ?

[haut]

auteur : nico-pyright(c)

Cela se passe dans le web.config, � la section pages/controls.


					  <system.web>
    <pages>
      <controls>
        <add tagPrefix="cc1" src="~/controls/ctl1.ascx" tagName="monUc"/>
      </controls>
    </pages>
  </system.web>

A utiliser ainsi dans une page :


					<cc1:monUc ID="MonUserControl" runat="server" />

� Version hors-ligne (Miroir)

Consultez les autres F.A.Q's

Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright © 2007 Dotnet Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site ni de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.