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が の場合、空の文字列 ("") が含まれているか、空白文字のみが含まれている場合、検証例外が発生します。

注意

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)