FromFormAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Package:: Microsoft.AspNetCore.App.Ref v10.0.0-preview.1.25120.3

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core 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.2

Source:: FromFormAttribute.cs

Source:: FromFormAttribute.cs

Source:: FromFormAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Specifies that a parameter or property should be bound using form-data in the request body.

public ref class FromFormAttribute : Attribute, Microsoft::AspNetCore::Mvc::ModelBinding::IBindingSourceMetadata, Microsoft::AspNetCore::Mvc::ModelBinding::IModelNameProvider

[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public class FromFormAttribute : Attribute, Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider

[System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public class FromFormAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IFromFormMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider

[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type FromFormAttribute = class
    inherit Attribute
    interface IBindingSourceMetadata
    interface IModelNameProvider

[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type FromFormAttribute = class
    inherit Attribute
    interface IBindingSourceMetadata
    interface IModelNameProvider
    interface IFromFormMetadata

Public Class FromFormAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IModelNameProvider

Public Class FromFormAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IFromFormMetadata, IModelNameProvider

Inheritance: Attribute
FromFormAttribute

Attributes: AttributeUsageAttribute

Implements: IBindingSourceMetadata IModelNameProvider IFromFormMetadata

Examples

In this example, the value of the 'name' field in the form-data request body is bound to the name parameter, and the value of the 'age' field is bound to the age parameter.

app.MapPost("/from-form", ([FromForm] string name, [FromForm] int age)
    => new { Name = name, Age = age });

Remarks

Binds a parameter or property to a field in a form-data request body with the same name, or the name specified in the Name property. Form parameter names are matched case-insensitively.

For more information about parameter binding see Parameter binding.

Constructors

FromFormAttribute()

Properties

BindingSource	Gets the BindingSource.
Name	The form field name.

Applies to

Share via