RequiredAttribute クラス

定義

データ フィールドの値が必須であることを指定します。Specifies that a data field value is required.

public ref class RequiredAttribute : System::ComponentModel::DataAnnotations::ValidationAttribute
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false)]
[System.AttributeUsage]
[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false)]
public class RequiredAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute
type RequiredAttribute = class
    inherit ValidationAttribute
Public Class RequiredAttribute
Inherits ValidationAttribute
継承
属性

次の例では、RequiredAttribute 属性を使用して、データフィールドを空にすることを許可するデータベーススキーマルールを上書きします。The following example uses the RequiredAttribute attribute to override the database schema rule that allows a data field to be empty. この例では、次の手順を実行します。The example performs the following steps:

  • メタデータ部分クラスと関連付けられたメタデータクラスを実装します。Implements a metadata partial class and the associated metadata class.

  • 関連付けられたメタデータクラスでは、次の要件を指定する RequiredAttribute 属性を適用します。In the associated metadata class, it applies the RequiredAttribute attribute, which specifies the following requirements:

    • タイトルデータフィールドを空にすることはできません。The Title data field cannot be empty. 検証が失敗した場合、この例のコードは検証例外をスローし、エラーメッセージを表示します。If validation fails, the code in the example throws a validation exception and displays an error message. エラーメッセージは、属性がデータフィールドに適用されたときに指定されます。The error message is specified at the time that the attribute is applied to the data field.

    • MiddleName data フィールドを空にすることはできません。The MiddleName data field cannot be empty. 検証が失敗した場合、この例のコードは検証例外をスローし、エラーメッセージを表示します。If validation fails, the code in the example throws a validation exception and displays an error message.

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 属性は、フォームのフィールドが検証されるときに、フィールドに値が含まれている必要があることを指定します。The RequiredAttribute attribute specifies that when a field on a form is validated, the field must contain a value. 検証例外は、プロパティが nullか、空の文字列 ("") が含まれているか、空白文字のみが含まれている場合に発生します。A validation exception is raised if the property is null, contains an empty string (""), or contains only white-space characters.

注意

MVC データモデルまたはエンティティ部分クラスに、RequiredAttribute 属性で注釈が付けられたフィールドが含まれていて、そのページにプロパティが含まれていない場合、エラーは発生しません。If the MVC data model or entity partial class contains a field that is annotated with the RequiredAttribute attribute, but the page does not contain the property, an error is not raised. 検証は、サーバーに送信されるフィールドに対してのみ行われます。Validation occurs only for fields that are submitted to the server.

コンストラクター

RequiredAttribute()

RequiredAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the RequiredAttribute class.

プロパティ

AllowEmptyStrings

空の文字列を使用できるかどうかを示す値を取得または設定します。Gets or sets a value that indicates whether an empty string is allowed.

ErrorMessage

検証が失敗した場合に検証コントロールに関連付けるエラー メッセージを取得または設定します。Gets or sets an error message to associate with a validation control if validation fails.

(継承元 ValidationAttribute)
ErrorMessageResourceName

検証が失敗した場合に ErrorMessageResourceType プロパティ値の検索に使用するエラー メッセージ リソース名を取得または設定します。Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails.

(継承元 ValidationAttribute)
ErrorMessageResourceType

検証が失敗した場合にエラー メッセージの検索に使用するリソースの種類を取得または設定します。Gets or sets the resource type to use for error-message lookup if validation fails.

(継承元 ValidationAttribute)
ErrorMessageString

ローカライズされた検証エラー メッセージを取得します。Gets the localized validation error message.

(継承元 ValidationAttribute)
RequiresValidationContext

属性で検証コンテキストが必要かどうかを示す値を取得します。Gets a value that indicates whether the attribute requires validation context.

(継承元 ValidationAttribute)
TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスが、指定されたオブジェクトと等価であるかどうかを示す値を返します。Returns a value that indicates whether this instance is equal to a specified object.

(継承元 Attribute)
FormatErrorMessage(String)

エラーが発生したデータ フィールドに基づいて、エラー メッセージに書式を適用します。Applies formatting to an error message, based on the data field where the error occurred.

(継承元 ValidationAttribute)
GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

(継承元 Attribute)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
GetValidationResult(Object, ValidationContext)

現在の検証属性に対して、指定した値が有効かどうかを確認します。Checks whether the specified value is valid with respect to the current validation attribute.

(継承元 ValidationAttribute)
IsDefaultAttribute()

派生クラスでオーバーライドされるとき、このインスタンスの値が派生クラスの既定値であるかどうかを示します。When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(継承元 Attribute)
IsValid(Object)

必須データ フィールドの値が空でないことをチェックします。Checks that the value of the required data field is not empty.

IsValid(Object, ValidationContext)

現在の検証属性に対して、指定した値を検証します。Validates the specified value with respect to the current validation attribute.

(継承元 ValidationAttribute)
Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
Validate(Object, String)

指定されたオブジェクトを検証します。Validates the specified object.

(継承元 ValidationAttribute)
Validate(Object, ValidationContext)

指定されたオブジェクトを検証します。Validates the specified object.

(継承元 ValidationAttribute)

明示的なインターフェイスの実装

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

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象