RequiredAttribute Класс

Определение

Пространство имен:

System.ComponentModel.DataAnnotations

Сборка:

System.ComponentModel.Annotations.dll

Исходный код:

RequiredAttribute.cs

Указывает, что требуется значение поля данных.

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

Наследование

Object

Attribute

ValidationAttribute

RequiredAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере атрибут используется RequiredAttribute для переопределения правила схемы базы данных, позволяющего пустому полю данных. В примере выполняются следующие действия.

• Реализует частичный класс метаданных и связанный класс метаданных.

• В связанном классе метаданных применяется RequiredAttribute атрибут, который задает следующие требования:

  • Поле данных Title не может быть пустым. Если проверка завершается ошибкой, код в примере вызывает исключение проверки и отображает сообщение об ошибке. Сообщение об ошибке указывается во время применения атрибута к полю данных.

  • Поле данных MiddleName не может быть пустым. Если проверка завершается ошибкой, код в примере вызывает исключение проверки и отображает сообщение об ошибке.

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

Комментарии

Атрибут RequiredAttribute указывает, что при проверке поля в форме поле должно содержать значение. Исключение проверки возникает, если свойство nullимеет значение, содержит пустую строку (""), или содержит только пробелы.

Note

Если модель данных MVC или разделяемый класс сущности содержит поле, аннотированное атрибутом RequiredAttribute , но страница не содержит свойства, возникает ошибка. Проверка выполняется только для полей, отправляемых на сервер.

Конструкторы

Имя	Описание
RequiredAttribute()	Инициализирует новый экземпляр класса RequiredAttribute.

Свойства

Имя	Описание
AllowEmptyStrings	Возвращает или задает значение, указывающее, разрешена ли пустая строка.
ErrorMessage	Возвращает или задает сообщение об ошибке для связывания с элементом управления проверки, если проверка завершается ошибкой. (Унаследовано от ValidationAttribute)
ErrorMessageResourceName	Возвращает или задает имя ресурса сообщения об ошибке для поиска ErrorMessageResourceType значения свойства, если проверка завершается ошибкой. (Унаследовано от ValidationAttribute)
ErrorMessageResourceType	Возвращает или задает тип ресурса, используемый для поиска сообщений об ошибке, если проверка завершается ошибкой. (Унаследовано от ValidationAttribute)
ErrorMessageString	Возвращает локализованное сообщение об ошибке проверки. (Унаследовано от ValidationAttribute)
RequiresValidationContext	Возвращает значение, указывающее, требуется ли для атрибута контекст проверки. (Унаследовано от ValidationAttribute)
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)

Методы

Имя	Описание
Equals(Object)	Возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
FormatErrorMessage(String)	Применяет форматирование к сообщению об ошибке на основе поля данных, в котором произошла ошибка. (Унаследовано от ValidationAttribute)
GetHashCode()	Возвращает хэш-код для этого экземпляра. (Унаследовано от Attribute)
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
GetValidationResult(Object, ValidationContext)	Проверяет, является ли указанное значение допустимым в отношении текущего атрибута проверки. (Унаследовано от ValidationAttribute)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
IsValid(Object, ValidationContext)	Проверяет указанное значение относительно текущего атрибута проверки. (Унаследовано от ValidationAttribute)
IsValid(Object)	Проверяет, что значение требуемого поля данных не является пустым.
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)
Validate(Object, String)	Проверяет указанный объект. (Унаследовано от ValidationAttribute)
Validate(Object, ValidationContext)	Проверяет указанный объект. (Унаследовано от ValidationAttribute)