RequiredAttribute Clase

Definición

Espacio de nombres:

System.ComponentModel.DataAnnotations

Ensamblado:

System.ComponentModel.Annotations.dll

Source:

RequiredAttribute.cs

Especifica que se requiere un valor de campo de datos.

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

Herencia

Object

Attribute

ValidationAttribute

RequiredAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo siguiente se usa el RequiredAttribute atributo para invalidar la regla de esquema de base de datos que permite que un campo de datos esté vacío. En el ejemplo se realizan los pasos siguientes:

• Implementa una clase parcial de metadatos y la clase de metadatos asociada.

• En la clase de metadatos asociada, aplica el RequiredAttribute atributo , que especifica los siguientes requisitos:

  • El campo Datos de título no puede estar vacío. Si se produce un error en la validación, el código del ejemplo produce una excepción de validación y muestra un mensaje de error. El mensaje de error se especifica en el momento en que se aplica el atributo al campo de datos.

  • El campo de datos MiddleName no puede estar vacío. Si se produce un error en la validación, el código del ejemplo produce una excepción de validación y muestra un mensaje de error.

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

Comentarios

El RequiredAttribute atributo especifica que cuando se valida un campo de un formulario, el campo debe contener un valor. Se produce una excepción de validación si la propiedad es null, contiene una cadena vacía ("") o solo contiene caracteres de espacio en blanco.

Nota

Si el modelo de datos MVC o la clase parcial de entidad contiene un campo anotado con el RequiredAttribute atributo , pero la página no contiene la propiedad , no se genera un error. La validación solo se produce para los campos que se envían al servidor.

Constructores

RequiredAttribute()

Inicializa una nueva instancia de la clase RequiredAttribute.

Propiedades

AllowEmptyStrings	Obtiene o establece un valor que indica si se permite una cadena vacía.
ErrorMessage	Obtiene o establece un mensaje de error que se va a asociar a un control de validación si se produce un error de validación. (Heredado de ValidationAttribute)
ErrorMessageResourceName	Obtiene o establece el nombre de recurso del mensaje de error que se va a usar para buscar el valor de la propiedad ErrorMessageResourceType si se produce un error en la validación. (Heredado de ValidationAttribute)
ErrorMessageResourceType	Obtiene o establece el tipo de recurso que se va a usar para buscar el mensaje de error si se produce un error de validación. (Heredado de ValidationAttribute)
ErrorMessageString	Obtiene el mensaje de error de validación traducido. (Heredado de ValidationAttribute)
RequiresValidationContext	Obtiene un valor que indica si el atributo requiere contexto de validación. (Heredado de ValidationAttribute)
TypeId	Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute. (Heredado de Attribute)

Métodos

Equals(Object)	Devuelve un valor que indica si esta instancia es igual que un objeto especificado. (Heredado de Attribute)
FormatErrorMessage(String)	Aplica formato a un mensaje de error según el campo de datos donde se produjo el error. (Heredado de ValidationAttribute)
GetHashCode()	Devuelve el código hash de esta instancia. (Heredado de Attribute)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
GetValidationResult(Object, ValidationContext)	Comprueba si el valor especificado es válido con respecto al atributo de validación actual. (Heredado de ValidationAttribute)
IsDefaultAttribute()	Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada. (Heredado de Attribute)
IsValid(Object)	Comprueba si el valor del campo de datos necesario no está vacío.
IsValid(Object, ValidationContext)	Valida el valor especificado con respecto al atributo de validación actual. (Heredado de ValidationAttribute)
Match(Object)	Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado. (Heredado de Attribute)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
Validate(Object, String)	Valida el objeto especificado. (Heredado de ValidationAttribute)
Validate(Object, ValidationContext)	Valida el objeto especificado. (Heredado de ValidationAttribute)