RequiredAttribute Classe

Definição

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Origem:

RequiredAttribute.cs

Especifica que o valor de um campo de dados é obrigatório.

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

Herança

Object

Attribute

ValidationAttribute

RequiredAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir usa o RequiredAttribute atributo para substituir a regra de esquema de banco de dados que permite que um campo de dados fique vazio. O exemplo executa as seguintes etapas:

• Implementa uma classe parcial de metadados e a classe de metadados associada.

• Na classe de metadados associada, ela aplica o RequiredAttribute atributo , que especifica os seguintes requisitos:

  • O campo de dados Título não pode estar vazio. Se a validação falhar, o código no exemplo gerará uma exceção de validação e exibirá uma mensagem de erro. A mensagem de erro é especificada no momento em que o atributo é aplicado ao campo de dados.

  • O campo de dados MiddleName não pode estar vazio. Se a validação falhar, o código no exemplo gerará uma exceção de validação e exibirá uma mensagem de erro.

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

Comentários

O RequiredAttribute atributo especifica que, quando um campo em um formulário é validado, o campo deve conter um valor. Uma exceção de validação será gerada se a propriedade for null, contiver uma cadeia de caracteres vazia ("" ou contiver apenas caracteres de espaço em branco.

Observação

Se o modelo de dados MVC ou a classe parcial de entidade contiver um campo anotado com o RequiredAttribute atributo , mas a página não contiver a propriedade , um erro não será gerado. A validação ocorre apenas para campos enviados ao servidor.

Construtores

RequiredAttribute()

Inicializa uma nova instância da classe RequiredAttribute.

Propriedades

AllowEmptyStrings	Obtém ou define um valor que indica se uma cadeia de caracteres vazia é permitida.
ErrorMessage	Obtém ou define uma mensagem de erro para associar a um controle de validação em caso de falha da validação. (Herdado de ValidationAttribute)
ErrorMessageResourceName	Obtém ou define o nome do recurso de mensagem de erro a ser usado para pesquisar o valor da propriedade ErrorMessageResourceType se a validação falhar. (Herdado de ValidationAttribute)
ErrorMessageResourceType	Obtém ou define o tipo de recurso a ser usado para a pesquisa de mensagens de erro se a validação falhar. (Herdado de ValidationAttribute)
ErrorMessageString	Obtém a mensagem de erro de validação localizada. (Herdado de ValidationAttribute)
RequiresValidationContext	Obtém ou define um valor que indica se o atributo requer contexto de validação. (Herdado de ValidationAttribute)
TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
FormatErrorMessage(String)	Aplica formatação a uma mensagem de erro com base no campo de dados em que ocorreu o erro. (Herdado de ValidationAttribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
GetValidationResult(Object, ValidationContext)	Verifica se o valor especificado é válido em relação ao atributo de validação atual. (Herdado de ValidationAttribute)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
IsValid(Object)	Verifica se o valor do campo de dados necessário não está vazio.
IsValid(Object, ValidationContext)	Valida o valor especificado em relação ao atributo de validação atual. (Herdado de ValidationAttribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Validate(Object, String)	Valida o objeto especificado. (Herdado de ValidationAttribute)
Validate(Object, ValidationContext)	Valida o objeto especificado. (Herdado de ValidationAttribute)