FormCollection Class

  • Article

Contains the form value providers for the application.

Inheritance Hierarchy

System.Object
  System.Collections.Specialized.NameObjectCollectionBase
    System.Collections.Specialized.NameValueCollection
      System.Web.Mvc.FormCollection

Namespace:  System.Web.Mvc
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)

Syntax

'Declaration
Public NotInheritable Class FormCollection _
    Inherits NameValueCollection _
    Implements IValueProvider

public sealed class FormCollection : NameValueCollection, 
    IValueProvider

public ref class FormCollection sealed : public NameValueCollection, 
    IValueProvider

The FormCollection type exposes the following members.

Constructors

  Name Description
Public method FormCollection() Initializes a new instance of the FormCollection class.
Public method FormCollection(NameValueCollection) Initializes a new instance of the FormCollection class.

Top

Properties

  Name Description
Public property AllKeys Gets all the keys in the NameValueCollection. (Inherited from NameValueCollection.)
Public property Count Gets the number of key/value pairs contained in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected property IsReadOnly Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (Inherited from NameObjectCollectionBase.)
Public property Item[String] Gets or sets the entry with the specified key in the NameValueCollection. (Inherited from NameValueCollection.)
Public property Item[Int32] Gets the entry at the specified index of the NameValueCollection. (Inherited from NameValueCollection.)
Public property Keys Gets a NameObjectCollectionBase.KeysCollection instance that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)

Top

Methods

  Name Description
Public method Add(NameValueCollection) Copies the entries in the specified NameValueCollection to the current NameValueCollection. (Inherited from NameValueCollection.)
Public method Add(String, String) Adds an entry with the specified name and value to the NameValueCollection. (Inherited from NameValueCollection.)
Protected method BaseAdd Adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseClear Removes all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGet(String) Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGet(Int32) Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGetAllKeys Returns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGetAllValues() Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGetAllValues(Type) Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseGetKey Gets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseHasKeys Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not null reference (Nothing in Visual Basic). (Inherited from NameObjectCollectionBase.)
Protected method BaseRemove Removes the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseRemoveAt Removes the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseSet(String, Object) Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected method BaseSet(Int32, Object) Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Public method Clear Invalidates the cached arrays and removes all entries from the NameValueCollection. (Inherited from NameValueCollection.)
Public method CopyTo Copies the entire NameValueCollection to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameValueCollection.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Get(String) Gets the values associated with the specified key from the NameValueCollection combined into one comma-separated list. (Inherited from NameValueCollection.)
Public method Get(Int32) Gets the values at the specified index of the NameValueCollection combined into one comma-separated list. (Inherited from NameValueCollection.)
Public method GetEnumerator Returns an enumerator that iterates through the NameObjectCollectionBase. (Inherited from NameObjectCollectionBase.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetKey Gets the key at the specified index of the NameValueCollection. (Inherited from NameValueCollection.)
Public method GetObjectData Implements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Gets the specified value provider.
Public method GetValues(String) Gets the values associated with the specified key from the NameValueCollection. (Inherited from NameValueCollection.)
Public method GetValues(Int32) Gets the values at the specified index of the NameValueCollection. (Inherited from NameValueCollection.)
Public method HasKeys Gets a value indicating whether the NameValueCollection contains keys that are not null reference (Nothing in Visual Basic). (Inherited from NameValueCollection.)
Protected method InvalidateCachedArrays Resets the cached arrays of the collection to null reference (Nothing in Visual Basic). (Inherited from NameValueCollection.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method OnDeserialization Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.)
Public method Remove Removes the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameValueCollection.)
Public method Set Sets the value of an entry in the NameValueCollection. (Inherited from NameValueCollection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method ToValueProvider Returns a dictionary that contains the value providers.

Top

Extension Methods

  Name Description
Public Extension Method CopyTo(IDictionary<String, Object>) Overloaded. Copies the specified collection to the specified destination. (Defined by NameValueCollectionExtensions.)
Public Extension Method CopyTo(IDictionary<String, Object>, Boolean) Overloaded. Copies the specified collection to the specified destination, and optionally replaces previous entries. (Defined by NameValueCollectionExtensions.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate method IValueProvider.ContainsPrefix Gets a value that indicates whether the value provider contains an entry that has the specified prefix.
Explicit interface implemetationPrivate method IValueProvider.GetValue Gets a value from a value provider using the specified key.
Explicit interface implemetationPrivate property ICollection.SyncRoot Gets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Web.Mvc Namespace