CustomValidator, classe

Utilisez le contrôle CustomValidator pour mettre en œuvre une fonction de validation définie par l'utilisateur pour un contrôle d'entrée. Le contrôle CustomValidator est un contrôle séparé du contrôle d'entrée qu'il valide, ce qui vous permet de contrôler où le message de validation est affiché.

Les contrôles de validation effectuent toujours une validation sur le serveur. Ils bénéficient également d'une implémentation côté client qui permet aux navigateurs activés pour les scripts (tels que Microsoft Internet Explorer 4.0 et versions ultérieures) d'effectuer une validation sur le client. La validation côté client améliore le processus de validation en vérifiant l'entrée d'utilisateur avant qu'elle soit envoyée au serveur. Cela permet de détecter d'éventuelles erreurs sur le client avant d'envoyer le formulaire, évitant ainsi l'aller-retour des informations nécessaire à une validation côté serveur.

Pour créer une fonction de validation côté serveur, fournissez un gestionnaire pour l'événement ServerValidate qui exécute la validation. La chaîne du contrôle d'entrée à valider est accessible au moyen de la propriété Value de l'objet ServerValidateEventArgs passée au gestionnaire d'événements sous forme de paramètre. Le résultat de la validation est ensuite stocké dans la propriété IsValid de l'objet ServerValidateEventArgs.

Pour créer une fonction de validation côté client, ajoutez d'abord la fonction de validation côté serveur décrite précédemment. Ensuite, ajoutez la fonction de script de validation côté client à la page ASP.NET (.aspx).

Si vous utilisez Visual Basic Scripting Edition (VBScript), la fonction doit se trouver dans le formulaire suivant :

 Sub ValidationFunctionName(source, arguments)

Si vous utilisez JScript, la fonction doit prendre la forme suivante :

 function ValidationFunctionName(source, arguments)

Le paramètre source est une référence à l'élément <span> rendu pour le contrôle CustomValidator. Cela vous permet de contrôler par programme la balise <span>, en modifiant l'attribut InnerHtml, par exemple. Le paramètre arguments est un objet ayant deux propriétés : Value et IsValid. Ce paramètre vous permet d'obtenir la valeur du contrôle à valider et d'indiquer si cette valeur est valide selon votre routine de validation personnalisée.

Utilisez la propriété ClientValidationFunction pour spécifier le nom de la fonction de script de validation côté client associée au contrôle CustomValidator. La fonction de script étant exécutée sur le client, elle doit être écrite dans un langage pris en charge par le navigateur cible, par exemple VBScript ou JScript.

Remarque
Lors de l'utilisation du contrôle CustomValidator au sein d'un contrôle UpdatePanel, veillez à ce que le contrôle du validateur et le contrôle auquel il est associé se trouvent dans le même panneau. Pour plus d'informations sur l'utilisation du contrôle UpdatePanel pour les mises à jour de pages partielles, consultez Vue d'ensemble du rendu de page partielle.

À l'instar de la validation côté serveur, la chaîne du contrôle d'entrée à valider est accessible à l'aide de la propriété Value du paramètre arguments. Retournez le résultat de la validation en définissant la propriété IsValid du paramètre arguments.

Attention

Lorsque vous utilisez des contrôles validateurs, vous devriez toujours vérifier les résultats de validation côté serveur avant d'exécuter tout traitement. Après une publication, mais avant que vos méthodes d'événement ne soient appelées, la page appelle les contrôles validateurs et regroupe leurs résultats dans la propriété Page.IsValid. (Vous pouvez également appeler explicitement les contrôles validateurs à l'aide de la méthode Validate.) Dans votre propre code, vous devriez vérifier que la propriété Page.IsValid retourne true avant de traiter une entrée. Bien que les navigateurs activés pour les scripts puissent empêcher une publication de se produire sur le client si la validation a échoué, vous devriez également toujours vérifier Page.IsValid dans le code serveur avant de traiter des données validées.

Plusieurs contrôles de validation peuvent être utilisés avec un contrôle d'entrée individuel pour valider différents critères. Par exemple, vous pouvez appliquer plusieurs contrôles de validation sur un contrôle TextBox qui permet à l'utilisateur d'entrer la quantité d'articles à ajouter dans un panier d'achat. Vous pouvez utiliser un contrôle CustomValidator pour vérifier que la valeur spécifiée est inférieure à la quantité en stock et un contrôle RequiredFieldValidator garantissant que l'utilisateur entre une valeur dans le contrôle TextBox.

Remarque
Si le contrôle d'entrée est vide, aucune fonction de validation n'est appelée et la validation s'effectue correctement. Utilisez un contrôle RequiredFieldValidator pour obliger l'utilisateur à entrer des données dans le contrôle d'entrée.

Il est possible d'utiliser un contrôle CustomValidator sans définir la propriété ControlToValidate. Cette situation est fréquente lorsque la validation porte sur plusieurs contrôles d'entrée ou sur des contrôles d'entrée qui ne peuvent pas être utilisés avec des contrôles de validation, tels que le contrôle CheckBox. Dans ce cas, la propriété Value du paramètre arguments passé au gestionnaire d'événements pour ServerValidate et à la fonction de validation côté client contient toujours une chaîne vide (""). Toutefois, ces fonctions de validation sont toujours appelées, lorsque cela est nécessaire, pour déterminer la validité au niveau du serveur et du client. Pour accéder à la valeur à valider, vous devez faire référence par programme au contrôle d'entrée que vous voulez valider, puis récupérer la valeur de la propriété adéquate. Par exemple, pour valider un contrôle CheckBox sur le serveur, ne définissez pas la propriété ControlToValidate du contrôle de validation et utilisez le code suivant pour le gestionnaire de l'événement ServerValidate :

void ServerValidation (object source, ServerValidateEventArgs args)
 {
    args.IsValid = (CheckBox1.Checked == true);
 }

Pour plus d'informations sur les contrôles de validation, consultez BaseValidator.

Accessibilité

L'exemple de code suivant illustre la création d'un contrôle CustomValidator côté serveur.

Note de sécurité
Cet exemple a une zone de texte qui accepte l'entrée d'utilisateur, ce qui constitue une menace éventuelle pour la sécurité. Par défaut, les pages Web ASP.NET vérifient que l'entrée d'utilisateur n'inclut pas de script ni d'éléments HTML. Pour plus d'informations, consultez Vue d'ensemble des attaques de script.

<%@ Page Language="C#" AutoEventWireup="True" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>CustomValidator ServerValidate Example</title>
<script runat="server">

      void ValidateBtn_OnClick(object sender, EventArgs e) 
      { 

         // Display whether the page passed validation.
         if (Page.IsValid) 
         {

            Message.Text = "Page is valid.";

         }

         else 
         {

            Message.Text = "Page is not valid!";

         }

      }

      void ServerValidation(object source, ServerValidateEventArgs args)
      {

         try 
         {

            // Test whether the value entered into the text box is even.
            int i = int.Parse(args.Value);
            args.IsValid = ((i%2) == 0);

         }

         catch(Exception ex)
         {

            args.IsValid = false;

         }

      }

   </script>    

</head>
<body>

   <form id="form1" runat="server">

      <h3>CustomValidator ServerValidate Example</h3>

      <asp:Label id="Message"  
           Text="Enter an even number:" 
           Font-Names="Verdana" 
           Font-Size="10pt" 
           runat="server"
           AssociatedControlID="Text1"/>

      <br />

      <asp:TextBox id="Text1" 
           runat="server" />

      &nbsp;&nbsp;

      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Names="verdana" 
           Font-Size="10pt"
           OnServerValidate="ServerValidation"
           runat="server"/>

      <br />

      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>

   </form>

</body>
</html>

L'exemple de code suivant illustre la création d'un contrôle CustomValidator côté client.

<%@ Page Language="C#" AutoEventWireup="True" %>

<html>
<head>

   <script runat="server">

      void ValidateBtn_OnClick(object sender, EventArgs e) 
      { 
         // Display whether the page passed validation.
         if (Page.IsValid) 
         {
            Message.Text = "Page is valid.";
         }

         else 
         {
            Message.Text = "Page is not valid!";
         }
      }

      void ServerValidation(object source, ServerValidateEventArgs args)
      {
         try 
         {
            // Test whether the value entered into the text box is even.
            int i = int.Parse(args.Value);
            args.IsValid = ((i%2) == 0);
         }

         catch(Exception ex)
         {
            args.IsValid = false;
         }
      }

   </script>    

</head>
<body>

   <form id="Form1" runat="server">

      <h3>CustomValidator ServerValidate Example</h3>

      <asp:Label id="Message"  
           Text="Enter an even number:" 
           Font-Name="Verdana" 
           Font-Size="10pt" 
           runat="server"/>

      <p>

      <asp:TextBox id="Text1" 
           runat="server" />

      &nbsp;&nbsp;

      <asp:CustomValidator id="CustomValidator1"
           ControlToValidate="Text1"
           ClientValidationFunction="ClientValidate"
           OnServerValidate="ServerValidation"
           Display="Static"
           ErrorMessage="Not an even number!"
           ForeColor="green"
           Font-Name="verdana" 
           Font-Size="10pt"
           runat="server"/>

      <p>

      <asp:Button id="Button1"
           Text="Validate" 
           OnClick="ValidateBtn_OnClick" 
           runat="server"/>

   </form>
</body>
</html>

<script language="javascript"> 
   function ClientValidate(source, arguments)
   {
        if (arguments.Value % 2 == 0 ){
            arguments.IsValid = true;
        } else {
            arguments.IsValid = false;
        }
   }
</script>

.NET Framework

Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2

Référence