ModelStateDictionary Class

Article
10/28/2015

Represents the state of an attempt to bind a posted form to an action method, which includes validation information.

Namespace: System.Web.Http.ModelBinding
Assembly: System.Web.Http (in System.Web.Http.dll)

Inheritance Hierarchy

System.Object
System.Web.Http.ModelBinding.ModelStateDictionary

Syntax

[SerializableAttribute]
[DefaultMemberAttribute("Item")]
public class ModelStateDictionary : IDictionary<string, ModelState>, 
    ICollection<KeyValuePair<string, ModelState>>, IEnumerable<KeyValuePair<string, ModelState>>, 
    IEnumerable

[SerializableAttribute]
[DefaultMemberAttribute("Item")]
public ref class ModelStateDictionary : IDictionary<String^, ModelState^>, 
    ICollection<KeyValuePair<String^, ModelState^>>, IEnumerable<KeyValuePair<String^, ModelState^>>, 
    IEnumerable

[<SerializableAttribute>]
[<DefaultMemberAttribute("Item")>]
type ModelStateDictionary = 
    class
        interface IDictionary<string, ModelState>
        interface ICollection<KeyValuePair<string, ModelState>>
        interface IEnumerable<KeyValuePair<string, ModelState>>
        interface IEnumerable
    end

<SerializableAttribute>
<DefaultMemberAttribute("Item")>
Public Class ModelStateDictionary
    Implements IDictionary(Of String, ModelState), ICollection(Of KeyValuePair(Of String, ModelState)),
    IEnumerable(Of KeyValuePair(Of String, ModelState)), IEnumerable

Constructors

	Name	Description
	ModelStateDictionary()	Initializes a new instance of the ModelStateDictionary class.
	ModelStateDictionary(ModelStateDictionary)	Initializes a new instance of the ModelStateDictionary class by using values that are copied from the specified model-state dictionary.

Properties

	Name	Description
	Count	Gets the number of key/value pairs in the collection.
	IsReadOnly	Gets a value that indicates whether the collection is read-only.
	IsValid	Gets a value that indicates whether this instance of the model-state dictionary is valid.
	Item[String]	Gets or sets the value that is associated with the specified key.
	Keys	Gets a collection that contains the keys in the dictionary.
	Values	Gets a collection that contains the values in the dictionary.

Methods

	Name	Description
	Add(KeyValuePair<String, ModelState>)	Adds the specified item to the model-state dictionary.
	Add(String, ModelState)	Adds an element that has the specified key and value to the model-state dictionary.
	AddModelError(String, Exception)	Adds the specified model error to the errors collection for the model-state dictionary that is associated with the specified key.
	AddModelError(String, String)	Adds the specified error message to the errors collection for the model-state dictionary that is associated with the specified key.
	Clear()	Removes all items from the model-state dictionary.
	Contains(KeyValuePair<String, ModelState>)	Determines whether the model-state dictionary contains a specific value.
	ContainsKey(String)	Determines whether the model-state dictionary contains the specified key.
	CopyTo(KeyValuePair<String, ModelState>[], Int32)	Copies the elements of the model-state dictionary to an array, starting at a specified index.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetEnumerator()	Returns an enumerator that can be used to iterate through the collection.
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsValidField(String)	Determines whether there are any ModelError objects that are associated with or prefixed with the specified key.
	MemberwiseClone()	(Inherited from Object.)
	Merge(ModelStateDictionary)	Copies the values from the specified ModelStateDictionary object into this dictionary, overwriting existing values if keys are the same.
	Remove(KeyValuePair<String, ModelState>)	Removes the first occurrence of the specified object from the model-state dictionary.
	Remove(String)	Removes the element that has the specified key from the model-state dictionary.
	SetModelValue(String, ValueProviderResult)	Sets the value for the specified key by using the specified value provider dictionary.
	ToString()	(Inherited from Object.)
	TryGetValue(String, ModelState)	Attempts to gets the value that is associated with the specified key.