RequiredAttribute Klasse

Definition

Gibt an, dass ein Datenfeldwert erforderlich ist.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)]
public class RequiredAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute
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
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
Vererbung
Attribute

Beispiele

Im folgenden Beispiel wird das- RequiredAttribute Attribut verwendet, um die Datenbankschema Regel zu überschreiben, die das Leeren eines Daten Felds ermöglicht.The following example uses the RequiredAttribute attribute to override the database schema rule that allows a data field to be empty. Das Beispiel führt die folgenden Schritte aus:The example performs the following steps:

  • Implementiert eine partielle Metadatenklasse und die zugehörige Metadatenklasse.Implements a metadata partial class and the associated metadata class.

  • In der zugehörigen Metadatenklasse wird das- RequiredAttribute Attribut angewendet, das die folgenden Anforderungen angibt:In the associated metadata class, it applies the RequiredAttribute attribute, which specifies the following requirements:

    • Das titeldatenfeld darf nicht leer sein.The Title data field cannot be empty. Wenn die Validierung fehlschlägt, löst der Code im Beispiel eine Validierungs Ausnahme aus und zeigt eine Fehlermeldung an.If validation fails, the code in the example throws a validation exception and displays an error message. Die Fehlermeldung wird zu dem Zeitpunkt angegeben, zu dem das Attribut auf das Datenfeld angewendet wird.The error message is specified at the time that the attribute is applied to the data field.

    • Das Daten Feld MiddleName darf nicht leer sein.The MiddleName data field cannot be empty. Wenn die Validierung fehlschlägt, löst der Code im Beispiel eine Validierungs Ausnahme aus und zeigt eine Fehlermeldung an.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

Hinweise

Das- RequiredAttribute Attribut gibt an, dass das Feld einen Wert enthalten muss, wenn ein Feld in einem Formular überprüft wird.The RequiredAttribute attribute specifies that when a field on a form is validated, the field must contain a value. Eine Validierungs Ausnahme wird ausgelöst, wenn die-Eigenschaft ist null , eine leere Zeichenfolge ("") enthält oder nur Leerzeichen enthält.A validation exception is raised if the property is null, contains an empty string (""), or contains only white-space characters.

Hinweis

Wenn das MVC-Datenmodell oder die partielle Entitäts Klasse ein Feld enthält, das mit dem-Attribut kommentiert wird RequiredAttribute , die Seite jedoch nicht die-Eigenschaft enthält, wird kein Fehler ausgelöst.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. Die Validierung erfolgt nur für Felder, die an den Server übermittelt werden.Validation occurs only for fields that are submitted to the server.

Konstruktoren

RequiredAttribute()

Initialisiert eine neue Instanz der RequiredAttribute-Klasse.Initializes a new instance of the RequiredAttribute class.

Eigenschaften

AllowEmptyStrings

Ruft einen Wert ab, der angibt, ob eine leere Zeichenfolge zulässig ist, oder legt diesen Wert fest.Gets or sets a value that indicates whether an empty string is allowed.

ErrorMessage

Ruft eine Fehlermeldung ab, die beim Fehlschlagen der Validierung einem Validierungssteuerelement zugeordnet wird, oder legt diese fest.Gets or sets an error message to associate with a validation control if validation fails.

(Geerbt von ValidationAttribute)
ErrorMessageResourceName

Ruft den Fehlermeldungsressourcennamen ab, mithilfe dessen der ErrorMessageResourceType-Eigenschaftswert nachgeschlagen werden soll, wenn die Validierung fehlschlägt, oder legt diesen fest.Gets or sets the error message resource name to use in order to look up the ErrorMessageResourceType property value if validation fails.

(Geerbt von ValidationAttribute)
ErrorMessageResourceType

Ruft den Ressourcentyp ab, der für die Fehlermeldungssuche verwendet werden soll, wenn die Validierung fehlschlägt, oder legt ihn fest.Gets or sets the resource type to use for error-message lookup if validation fails.

(Geerbt von ValidationAttribute)
ErrorMessageString

Ruft die lokalisierte Validierungsfehlermeldung ab.Gets the localized validation error message.

(Geerbt von ValidationAttribute)
RequiresValidationContext

Ruft einen Wert ab, der angibt, ob das Attribut Validierungskontext erfordert.Gets a value that indicates whether the attribute requires validation context.

(Geerbt von ValidationAttribute)
TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Geerbt von Attribute)

Methoden

Equals(Object)

Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.Returns a value that indicates whether this instance is equal to a specified object.

(Geerbt von Attribute)
FormatErrorMessage(String)

Wendet eine Formatierung auf eine Fehlermeldung auf Grundlage des Datenfelds an, in dem der Fehler aufgetreten ist.Applies formatting to an error message, based on the data field where the error occurred.

(Geerbt von ValidationAttribute)
GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

(Geerbt von Attribute)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
GetValidationResult(Object, ValidationContext)

Überprüft, ob der angegebene Wert in Bezug auf das aktuelle Validierungsattribut gültig ist.Checks whether the specified value is valid with respect to the current validation attribute.

(Geerbt von ValidationAttribute)
IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Geerbt von Attribute)
IsValid(Object)

Überprüft, dass der Wert des erforderlichen Datenfelds nicht leer ist.Checks that the value of the required data field is not empty.

IsValid(Object, ValidationContext)

Überprüft den angegebenen Wert in Bezug auf das aktuelle Validierungsattribut.Validates the specified value with respect to the current validation attribute.

(Geerbt von ValidationAttribute)
Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Geerbt von Attribute)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)
Validate(Object, String)

Validiert das angegebene Objekt.Validates the specified object.

(Geerbt von ValidationAttribute)
Validate(Object, ValidationContext)

Validiert das angegebene Objekt.Validates the specified object.

(Geerbt von ValidationAttribute)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Geerbt von Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Geerbt von Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Geerbt von Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Geerbt von Attribute)

Gilt für: