This topic has not yet been rated - Rate this topic

RequiredAttribute Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies that a data field value is required.

System.Object
  System.Attribute
    System.ComponentModel.DataAnnotations.ValidationAttribute
      System.ComponentModel.DataAnnotations.RequiredAttribute

Namespace:  System.ComponentModel.DataAnnotations
Assembly:  System.ComponentModel.DataAnnotations (in System.ComponentModel.DataAnnotations.dll)
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field|AttributeTargets.Parameter, AllowMultiple = false)]
public class RequiredAttribute : ValidationAttribute

The RequiredAttribute type exposes the following members.

  Name Description
Public method RequiredAttribute Initializes a new instance of the RequiredAttribute class.
Top
  Name Description
Public property AllowEmptyStrings Gets or sets a value that indicates whether an empty string is allowed.
Public property ErrorMessage Gets or sets an error message to associate with a validation control if validation fails. (Inherited from ValidationAttribute.)
Public property ErrorMessageResourceName Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails. (Inherited from ValidationAttribute.)
Public property ErrorMessageResourceType Gets or sets the resource type to use for error-message lookup if validation fails. (Inherited from ValidationAttribute.)
Protected property ErrorMessageString Gets the localized validation error message. (Inherited from ValidationAttribute.)
Public property RequiresValidationContext Gets a value that indicates whether the attribute requires validation context. (Inherited from ValidationAttribute.)
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FormatErrorMessage Applies formatting to an error message, based on the data field where the error occurred. (Inherited from ValidationAttribute.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValidationResult Checks whether the specified value is valid with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method IsValid(Object) Checks that the value of the required data field is not empty. (Overrides ValidationAttribute.IsValid(Object).)
Protected method IsValid(Object, ValidationContext) Validates the specified value with respect to the current validation attribute. (Inherited from ValidationAttribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Validate(Object, ValidationContext) Validates the specified object. (Inherited from ValidationAttribute.)
Public method Validate(Object, String) Validates the specified object. (Inherited from ValidationAttribute.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

The RequiredAttribute attribute specifies that when a field on a form is validated, the field must contain a value. A validation exception is raised if the property is null, contains an empty string (""), or contains only white-space characters.

Note Note

If the MVC data model or entity partial class contains a field that is annotated with the RequiredAttribute attribute, but the page does not contain the property, an error is not raised. Validation occurs only for fields that are submitted to the server.

A Visual Studio project with source code is available to accompany this topic: Download.

The following example uses the RequiredAttribute attribute to override the database schema rule that allows a data field to be empty. The example performs the following steps:

  • Implements a metadata partial class and the associated metadata class.

  • In the associated metadata class, it applies the RequiredAttribute attribute, which specifies the following requirements:

    • The Title data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message. The error message is specified at the time that the attribute is applied to the data field.

    • The MiddleName data field cannot be empty. If validation fails, the code in the example throws a validation exception and displays an error message.


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;

}



.NET Framework

Supported in: 4.5, 4, 3.5 SP1

.NET Framework Client Profile

Supported in: 4

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)