ModelStateDictionary.TryAddModelError Method

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.ModelBinding
Assembly:
Microsoft.AspNetCore.Mvc.Abstractions.dll
Package:
Microsoft.AspNetCore.Mvc.Abstractions v1.0.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v1.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0
Package:
Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Overloads

TryAddModelError(String, Exception, ModelMetadata)

Attempts to add the specified exception to the Errors instance that is associated with the specified key. If the maximum number of allowed errors has already been recorded, ensures that a TooManyModelErrorsException exception is recorded instead.
TryAddModelError(String, String)

Attempts to add the specified errorMessage to the Errors instance that is associated with the specified key. If the maximum number of allowed errors has already been recorded, ensures that a TooManyModelErrorsException exception is recorded instead.

TryAddModelError(String, Exception, ModelMetadata)

Source:
ModelStateDictionary.cs
Source:
ModelStateDictionary.cs
Source:
ModelStateDictionary.cs

Attempts to add the specified exception to the Errors instance that is associated with the specified key. If the maximum number of allowed errors has already been recorded, ensures that a TooManyModelErrorsException exception is recorded instead.

public:
 bool TryAddModelError(System::String ^ key, Exception ^ exception, Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ metadata);
public bool TryAddModelError (string key, Exception exception, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata metadata);
member this.TryAddModelError : string * Exception * Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata -> bool
Public Function TryAddModelError (key As String, exception As Exception, metadata As ModelMetadata) As Boolean

Parameters

key
String

The key of the ModelStateEntry to add errors to.

exception
Exception

The Exception to add. Some exception types will be replaced with a descriptive error message.

metadata
ModelMetadata

The ModelMetadata associated with the model.

Returns

Boolean

True if the given error was added, false if the error was ignored. See MaxAllowedErrors.

Applies to

TryAddModelError(String, String)

Source:
ModelStateDictionary.cs
Source:
ModelStateDictionary.cs
Source:
ModelStateDictionary.cs

Attempts to add the specified errorMessage to the Errors instance that is associated with the specified key. If the maximum number of allowed errors has already been recorded, ensures that a TooManyModelErrorsException exception is recorded instead.

public:
 bool TryAddModelError(System::String ^ key, System::String ^ errorMessage);
public bool TryAddModelError (string key, string errorMessage);
member this.TryAddModelError : string * string -> bool
Public Function TryAddModelError (key As String, errorMessage As String) As Boolean

Parameters

key
String

The key of the ModelStateEntry to add errors to.

errorMessage
String

The error message to add.

Returns

Boolean

True if the given error was added, false if the error was ignored. See MaxAllowedErrors.

Applies to