Guide pratique pour valider des paramètres d'application

Cette rubrique illustre la validation des paramètres d’application avant qu’ils ne soient rendus persistants.

Les paramètres d’application fortement typés empêchent les utilisateurs d’affecter les données d’un type incorrect pour un paramètre donné. Toutefois, un utilisateur peut essayer d’assigner une valeur à un paramètre qui se situe en dehors des limites acceptables, par exemple en fournissant une date de naissance future. ApplicationSettingsBase, la classe parente de toutes les classes de paramètres d’application expose quatre événements pour activer ces limites case activée ing. La gestion de ces événements place la totalité de votre code de validation dans un emplacement unique, plutôt que de le répartir dans votre projet.

L’événement que vous utilisez dépend du moment où vous devez valider vos paramètres, comme décrit dans le tableau suivant.

En règle générale, vous n’utiliserez pas tous ces événements dans la même application à des fins de validation. Par exemple, il est souvent possible de répondre à toutes les exigences de validation en gérant uniquement l’événement SettingChanging .

Un gestionnaire d’événements exécute généralement l’une des actions suivantes lorsqu’il détecte une valeur non valide :

• Fournit automatiquement une valeur correcte, par exemple la valeur par défaut.

• Interroge de nouveau l’utilisateur de code serveur pour plus d’informations.

• Pour les événements déclenchés avant leurs actions associées, telles que SettingChanging et SettingsSaving, utilise l’argument CancelEventArgs pour annuler l’opération.

Pour plus d’informations sur la gestion des événements, consultez Vue d’ensemble des gestionnaires d’événements.

Les procédures suivantes montrent comment tester une date de naissance valide à l’aide de l’événement SettingChanging ou de l’événement SettingsSaving . Ces procédures ont été écrites en supposant que vous avez déjà créé vos paramètres d’application. Dans cet exemple, nous vérifions les limites d’un paramètre nommé DateOfBirth. Pour plus d’informations sur la création de paramètres, consultez Comment : créer des paramètres d’application.

Pour obtenir l’objet des paramètres de l’application

• Obtenez une référence à l’objet des paramètres d’application (instance de wrapper) en respectant l’un des éléments de la liste suivante :

  • Si vous avez créé vos paramètres à l’aide de la boîte de dialogue Paramètres de l’application Visual Studio de l’éditeur de propriétés, vous pouvez récupérer l’objet de paramètres par défaut généré pour votre langage par le biais de l’expression suivante.

    Properties.Settings.Default
    

    MySettings.Default
    

    -ou-

  • Si vous êtes un développeur Visual Basic et si vous avez créé vos paramètres d’application à l’aide du Concepteur de projet, vous pouvez récupérer vos paramètres à l’aide de l’objet My.Settings.

    -ou-

  • Si vous avez créé vos paramètres en dérivant ApplicationSettingsBase directement, vous devez instancier votre classe manuellement.

    MyCustomSettings settings = new MyCustomSettings();
    

    Dim Settings as New MyCustomSettings()
    

Les procédures suivantes ont été écrites en supposant que l’objet des paramètres d’application a été obtenu par le biais du dernier élément répertorié dans cette procédure.

Pour valider les paramètres de l’application lors de la modification d’un paramètre

1. Si vous êtes développeur C#, dans l’événement de Load votre formulaire ou contrôle, ajoutez un gestionnaire d’événements pour l’événement SettingChanging .

   -ou-

   Si vous êtes un développeur Visual Basic, vous devez déclarer la variable Settings à l’aide du mot cléWithEvents.

   public void Form1_Load(Object sender, EventArgs e)
   {
       settings.SettingChanging += new SettingChangingEventHandler(MyCustomSettings_SettingChanging);
   }
   

   Public Sub Form1_Load(sender as Object, e as EventArgs)
       AddHandler settings.SettingChanging, AddressOf MyCustomSettings_SettingChanging
   End Sub
   

2. Définissez le gestionnaire d’événements et insérez-y le code pour vérifier les limites de la date de naissance.

   private void MyCustomSettings_SettingChanging(Object sender, SettingChangingEventArgs e)
   {
       if (e.SettingName.Equals("DateOfBirth"))
       {
           var newDate = (DateTime)e.NewValue;
           if (newDate > DateTime.Now)
           {
               e.Cancel = true;
               // Inform the user.
           }
       }
   }
   

   Private Sub MyCustomSettings_SettingChanging(sender as Object, e as SettingChangingEventArgs) Handles Settings.SettingChanging
       If (e.SettingName.Equals("DateOfBirth")) Then
           Dim NewDate as Date = CType(e.NewValue, Date)
           If (NewDate > Date.Now) Then
               e.Cancel = True
               ' Inform the user.
           End If
       End If
   End Sub
   

Pour valider les paramètres d’application en cas d’enregistrement

1. Dans l’événement de Load votre formulaire ou contrôle, ajoutez un gestionnaire d’événements pour l’événement SettingsSaving .

   public void Form1_Load(Object sender, EventArgs e)
   {
       settings.SettingsSaving += new SettingsSavingEventHandler(MyCustomSettings_SettingsSaving);
   }
   

   Public Sub Form1_Load(Sender as Object, e as EventArgs)
       AddHandler settings.SettingsSaving, AddressOf MyCustomSettings_SettingsSaving
   End Sub
   

2. Définissez le gestionnaire d’événements et insérez-y le code pour vérifier les limites de la date de naissance.

   private void MyCustomSettings_SettingsSaving(Object sender, SettingsSavingEventArgs e)
   {
       if (this["DateOfBirth"] > Date.Now) {
           e.Cancel = true;
       }
   }
   

   Private Sub MyCustomSettings_SettingsSaving(Sender as Object, e as SettingsSavingEventArgs)
       If (Me["DateOfBirth"] > Date.Now) Then
           e.Cancel = True
       End If
   End Sub
   

Voir aussi

• Création de gestionnaires d'événements dans les Windows Forms
• Comment : créer des paramètres d’application