RequiredAttribute Classe

Definição

Especifica que é necessário um valor de campo de dados.

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.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
[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)>]
type RequiredAttribute = class
    inherit ValidationAttribute
Public Class RequiredAttribute
Inherits ValidationAttribute
Herança
Atributos

Exemplos

O exemplo seguinte utiliza o RequiredAttribute atributo para sobrepor a regra do esquema da base de dados que permite que um campo de dados fique vazio. O exemplo executa os seguintes passos:

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

  • Na classe de metadados associada, aplica-se 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 lança uma exceção de validação e exibe 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 lança uma exceção de validação e exibe 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

Observações

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

Note

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

Construtores

Name Description
RequiredAttribute()

Inicializa uma nova instância da RequiredAttribute classe.

Propriedades

Name Description
AllowEmptyStrings

Recebe ou define um valor que indica se uma cadeia vazia é permitida.

ErrorMessage

Recebe ou define uma mensagem de erro para associar a um controlo de validação se a validação falhar.

(Herdado de ValidationAttribute)
ErrorMessageResourceName

Recebe ou define o nome do recurso da mensagem de erro para ser usado para consultar o valor da ErrorMessageResourceType propriedade caso a validação falhe.

(Herdado de ValidationAttribute)
ErrorMessageResourceType

Obtém ou define o tipo de recurso a usar para a consulta de mensagens de erro caso a validação falhe.

(Herdado de ValidationAttribute)
ErrorMessageString

Recebe a mensagem de erro de validação localizada.

(Herdado de ValidationAttribute)
RequiresValidationContext

Obtém um valor que indica se o atributo requer contexto de validação.

(Herdado de ValidationAttribute)
TypeId

Quando implementado numa classe derivada, obtém um identificador único para esta Attribute.

(Herdado de Attribute)

Métodos

Name Description
Equals(Object)

Devolve um valor que indica se esta 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 onde ocorreu o erro.

(Herdado de ValidationAttribute)
GetHashCode()

Devolve o código de hash para esta 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 relativamente ao atributo de validação atual.

(Herdado de ValidationAttribute)
IsDefaultAttribute()

Quando sobrescrito numa classe derivada, indica se o valor desta instância é o valor padrão para a classe derivada.

(Herdado de Attribute)
IsValid(Object, ValidationContext)

Valida o valor especificado em relação ao atributo de validação atual.

(Herdado de ValidationAttribute)
IsValid(Object)

Verifica se o valor do campo de dados requerido não está vazio.

Match(Object)

Quando sobrescrito numa classe derivada, devolve um valor que indica se esta instância é igual a um objeto especificado.

(Herdado de Attribute)
MemberwiseClone()

Cria uma cópia superficial do atual Object.

(Herdado de Object)
ToString()

Devolve uma cadeia 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)

Implementações de Interface Explícita

Name Description
_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mapeia um conjunto de nomes para um conjunto correspondente de identificadores de despacho.

(Herdado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Recupera a informação de tipo de um objeto, que pode ser usada para obter a informação de tipo para uma interface.

(Herdado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera o número de interfaces de informações de tipo que um objeto fornece (0 ou 1).

(Herdado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acesso a propriedades e métodos expostos por um objeto.

(Herdado de Attribute)

Aplica-se a