| 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 ?)
|
| 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.
|
| 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.
|
| 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
|
| 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 " / >
|
|
| 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
|
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)
Dim constructeur As ConstructorInfo = uc. GetType (). BaseType . GetConstructor (constParamTypes. ToArray ())
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'
|
|
Consultez les autres F.A.Q's
Les sources présentés sur cette pages sont libre de droits,
et vous pouvez les utiliser à votre convenance. Par contre cette page de présentation de ces sources constitue une oeuvre intellectuelle protégée par les droits d'auteurs.
Copyright ©2007
Developpez LLC. Tout droits réservés Developpez LLC.
Aucune reproduction, même partielle, ne peut être faite de ce site et de
l'ensemble de son contenu : textes, documents et images sans l'autorisation
expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à 3 ans
de prison et jusqu'à 300 000 E de dommages et intérets.
Cette page est déposée à la SACD.
|