FormAttribute Class

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents an attribute that specifies that values for model binding are provided by a form field.

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

Inheritance Hierarchy

System.Object
System.Attribute
System.Web.ModelBinding.ValueProviderSourceAttribute
System.Web.ModelBinding.FormAttribute

Syntax

C++

[AttributeUsageAttribute(AttributeTargets.Parameter, Inherited = false, 
	AllowMultiple = false)]
public sealed class FormAttribute : ValueProviderSourceAttribute, 
	IUnvalidatedValueProviderSource, IValueProviderSource

Constructors

	Name	Description
	FormAttribute()	Initializes a new instance of the FormAttribute class.
	FormAttribute(String)	Initializes a new instance of the FormAttribute class using the specified form field name.

Properties

	Name	Description
	FieldName	Gets the name of the form field.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)
	ValidateInput	Gets or sets a value that indicates whether the form data is validated.

Methods

	Name	Description
	Equals(Object)	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)
	GetHashCode()	Returns the hash code for this instance.(Inherited from Attribute.)
	GetModelName()	Gets the model name.(Overrides ValueProviderSourceAttribute.GetModelName().)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	GetValueProvider(ModelBindingExecutionContext)	Gets the value provider.(Overrides ValueProviderSourceAttribute.GetValueProvider(ModelBindingExecutionContext).)
	IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)
	Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from 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.(Inherited from Attribute.)
	_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

Remarks

For a tutorial series on using model binding with Web Forms, see Model Binding and Web Forms.

Version Information

.NET Framework
Available since 4.5

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.