RequiredAttribute Classe

Définition

Espace de noms:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.DataAnnotations.dll

Spécifie qu’une valeur de champ de données est requise.

public ref class RequiredAttribute : System::ComponentModel::DataAnnotations::ValidationAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
public class RequiredAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)>]
type RequiredAttribute = class
    inherit ValidationAttribute

Public Class RequiredAttribute
Inherits ValidationAttribute

Héritage

Object

Attribute

ValidationAttribute

RequiredAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple suivant utilise l’attribut pour remplacer la RequiredAttribute règle de schéma de base de données qui permet à un champ de données d’être vide. L’exemple effectue les étapes suivantes :

• Implémente une classe partielle de métadonnées et la classe de métadonnées associée.

• Dans la classe de métadonnées associée, elle applique l’attribut RequiredAttribute , qui spécifie les exigences suivantes :

  • Le champ de données Titre ne peut pas être vide. Si la validation échoue, le code de l’exemple lève une exception de validation et affiche un message d’erreur. Le message d’erreur est spécifié au moment où l’attribut est appliqué au champ de données.

  • Le champ de données MiddleName ne peut pas être vide. Si la validation échoue, le code de l’exemple lève une exception de validation et affiche un message d’erreur.

using System;
using System.Web.DynamicData;
using System.ComponentModel.DataAnnotations;
using System.Globalization;

[MetadataType(typeof(CustomerMetaData))]
public partial class Customer
{
}

public class CustomerMetaData
{
    // Require that the Title is not null.
    // Use custom validation error.
    [Required(ErrorMessage = "Title is required.")]
    public object Title;
    
    // Require that the MiddleName is not null.
    // Use standard validation error.
    [Required()]
    public object MiddleName;
}

Imports System.Web.DynamicData
Imports System.ComponentModel.DataAnnotations
Imports System.Globalization

<MetadataType(GetType(CustomerMetaData))> _
Partial Public Class Customer

   
End Class

Public Class CustomerMetaData
    ' Require that the Title is not null.
    ' Use custom validation error.
    <Required(ErrorMessage:="Title is required.")> _
    Public Title As Object

    ' Require that the MiddleName is not null.
    ' Use standard validation error.
    <Required()> _
    Public MiddleName As Object

End Class

Remarques

L’attribut RequiredAttribute spécifie que lorsqu’un champ d’un formulaire est validé, le champ doit contenir une valeur. Une exception de validation est levée si la propriété est null, contient une chaîne vide («  ») ou contient uniquement des caractères d’espace blanc.

Note

Si le modèle de données MVC ou la classe partielle d’entité contient un champ annoté avec l’attribut RequiredAttribute , mais que la page ne contient pas la propriété, une erreur n’est pas générée. La validation se produit uniquement pour les champs soumis au serveur.

Constructeurs

Nom	Description
RequiredAttribute()	Initialise une nouvelle instance de la classe RequiredAttribute.

Propriétés

Nom	Description
AllowEmptyStrings	Obtient ou définit une valeur qui indique si une chaîne vide est autorisée.
ErrorMessage	Obtient ou définit un message d’erreur à associer à un contrôle de validation en cas d’échec de la validation. (Hérité de ValidationAttribute)
ErrorMessageResourceName	Obtient ou définit le nom de la ressource de message d’erreur à utiliser pour rechercher la valeur de propriété ErrorMessageResourceType en cas d’échec de la validation. (Hérité de ValidationAttribute)
ErrorMessageResourceType	Obtient ou définit le type de ressource à utiliser pour la recherche de message d’erreur en cas d’échec de la validation. (Hérité de ValidationAttribute)
ErrorMessageString	Obtient le message d’erreur de validation localisé. (Hérité de ValidationAttribute)
RequiresValidationContext	Obtient une valeur qui indique si l’attribut nécessite un contexte de validation. (Hérité de ValidationAttribute)
TypeId	En cas d’implémentation dans une classe dérivée, obtient un identificateur unique pour cette Attribute. (Hérité de Attribute)

Méthodes

Nom	Description
Equals(Object)	Retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
FormatErrorMessage(String)	Applique la mise en forme à un message d’erreur, en fonction du champ de données où l’erreur s’est produite. (Hérité de ValidationAttribute)
GetHashCode()	Retourne le code de hachage pour cette instance. (Hérité de Attribute)
GetType()	Obtient la Type de l’instance actuelle. (Hérité de Object)
GetValidationResult(Object, ValidationContext)	Vérifie si la valeur spécifiée est valide par rapport à l’attribut de validation actuel. (Hérité de ValidationAttribute)
IsDefaultAttribute()	En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut de la classe dérivée. (Hérité de Attribute)
IsValid(Object, ValidationContext)	Valide la valeur spécifiée par rapport à l’attribut de validation actuel. (Hérité de ValidationAttribute)
IsValid(Object)	Vérifie que la valeur du champ de données requis n’est pas vide.
Match(Object)	En cas de substitution dans une classe dérivée, retourne une valeur qui indique si cette instance est égale à un objet spécifié. (Hérité de Attribute)
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)
Validate(Object, String)	Valide l’objet spécifié. (Hérité de ValidationAttribute)
Validate(Object, ValidationContext)	Valide l’objet spécifié. (Hérité de ValidationAttribute)

Implémentations d’interfaces explicites

Nom	Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch. (Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Récupère les informations de type d’un objet, qui peuvent être utilisées pour obtenir les informations de type d’une interface. (Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1). (Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Fournit l’accès aux propriétés et méthodes exposées par un objet. (Hérité de Attribute)