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 ，它會套用 屬性，指定下列需求：

  • [標題數據] 欄位不可為空白。 如果驗證失敗，範例中的程式代碼會擲回驗證例外狀況，並顯示錯誤訊息。 錯誤訊息會在屬性套用至數據欄位時指定。

  • 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，則會引發驗證例外狀況，其中包含空字串 (“”) ，或只包含空格符。

注意

如果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)	檢查必要資料欄位的值是否不為空白。
IsValid(Object, ValidationContext)	根據目前的驗證屬性，驗證指定的值。 (繼承來源 ValidationAttribute)
Match(Object)	在衍生類別中覆寫時，會傳回值，表示這個執行個體是否等於指定物件。 (繼承來源 Attribute)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)
Validate(Object, String)	驗證指定的物件。 (繼承來源 ValidationAttribute)
Validate(Object, ValidationContext)	驗證指定的物件。 (繼承來源 ValidationAttribute)