FAQ ASP.NET/C#Consultez toutes les FAQ

Nombre d'auteurs : 39, nombre de questions : 371, dernière mise à jour : 30 mars 2017 

 
OuvrirSommaireWebFormsContrôlesContrôles utilisateur (User Controls)

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 :

 
Sélectionnez

<%@ 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

Image non disponible

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 ?)

Créé le 10 mars 2008  par 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 :

 
Sélectionnez

<%@ 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 :

 
Sélectionnez

<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.

Créé le 10 mars 2008  par nico-pyright(c)

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

 
Sélectionnez

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

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

 
Sélectionnez

protected System.Web.UI.WebControls.Label monLabel;

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

Créé le 10 mars 2008  par 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 :

 
Sélectionnez

monUserControl uc = 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.

 
Sélectionnez

monUserControl uc = (monUserControl) LoadControl("~/monUserControl.ascx");
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.

Créé le 10 mars 2008  par nico-pyright(c)

Le mieux est de l'expliquer par un exemple: Imaginons que nous développons un petit contrôle permet de rechercher dans la base de données des utilisateurs. Ce qui nous interresse dans cette base sont le nom et le prénom de la personne sélectionnée et d'utiliser ces valeurs dans un traitement quelconque. Pour cela, il suffit de définir des propriétés au contrôle, par exemple:

 
Sélectionnez

public string SelectedName
{
	get { return DdlUsers.SelectedValue.Split(',')[0]; }
}

public string SelectedFirstName
{
	get { return DdlUsers.SelectedValue.Split(',')[1]; }
}
...
				

Dans la page qui héberge le WebControl, il suffit alors de lui donner la référence du WebControl:

 
Sélectionnez

protected SearchPeople Sp;
				

Il suffit alors de l'utiliser comme tous les autres composants inclus dans ASP.NET:

 
Sélectionnez

LaTest.Text = "Nom : " + Sp.SelectedName + ", Prenom: " + Sp.SelectedFirstName;
				
Créé le 23 mai 2005  par Didier Danse

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 :

 
Sélectionnez

public partial class monUserControl : UserControl
{
	private string _maValeur;

	public string MaValeur
	{
		get { return _maValeur; }
		set { _maValeur = value; }
	}

	protected override void OnInit(EventArgs e)
	{
		monLabel.Text = _maValeur;
		base.OnInit(e);
	}
}

dans la page.aspx

 
Sélectionnez

<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

Créé le 10 mars 2008  par 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 :

 
Sélectionnez

public partial class monUserControl : UserControl
{
	private readonly string _maValeur;
	public monUserControl()
	{
	}

	public monUserControl(string valeur)
	{
		_maValeur = valeur;
	}

	protected override void OnInit(EventArgs e)
	{
		if (string.IsNullOrEmpty(_maValeur))
			monLabel.Text = "Valeur par défaut";
		else
			monLabel.Text = _maValeur;
		base.OnInit(e);
	}
}

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

 
Sélectionnez

public static UserControl LoadControl(Page page, string pathControleUtilisateur, params object[] parametresConstructeur)
{
	List<Type> constParamTypes = new List<Type>();
	foreach (object constParam in parametresConstructeur)
		constParamTypes.Add(constParam.GetType());
	UserControl uc = (UserControl)page.LoadControl(pathControleUtilisateur);
	// trouve le constructeur
	ConstructorInfo constructeur = uc.GetType().BaseType.GetConstructor(constParamTypes.ToArray());
	// et l'invoke
	if (constructeur == null)
		throw new MemberAccessException("Contrôle utilisateur non trouvé : " + uc.GetType().BaseType);
	else
		constructeur.Invoke(uc, parametresConstructeur);
	return uc;
}

A utiliser ainsi :

 
Sélectionnez

monUserControl uc = (monUserControl) LoadControl(Page, "~/monUserControl.ascx", "Ma valeur passée");
MonPlaceHolder.Controls.Add(uc);

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

 
Sélectionnez

CS1501: Aucune surcharge pour la méthode 'monUserControl' ne prend d'arguments '0'
				
Créé le 10 mars 2008  par nico-pyright(c)

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

 
Sélectionnez

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

A utiliser ainsi dans une page :

 
Sélectionnez

<cc1:monUc ID="MonUserControl" runat="server" />
Créé le 13 octobre 2008  par nico-pyright(c)

Non ce n'est pas possible. Un user control est prévu pour être ajouté dans une Webform (.aspx).

Pour le visualiser, vous devez donc l'ajouter à une page web et afficher cette page dans le browser.

Créé le 29 mai 2006  par Didier Danse
  

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 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'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.