Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

FromHeaderAttribute Class

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
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
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.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
FromHeaderAttribute.cs
Source:
FromHeaderAttribute.cs
Source:
FromHeaderAttribute.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 the request headers.

public ref class FromHeaderAttribute : 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 FromHeaderAttribute : 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 FromHeaderAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IFromHeaderMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider
[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type FromHeaderAttribute = class
 inherit Attribute
 interface IBindingSourceMetadata
 interface IModelNameProvider
[<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type FromHeaderAttribute = class
 inherit Attribute
 interface IBindingSourceMetadata
 interface IModelNameProvider
 interface IFromHeaderMetadata
Public Class FromHeaderAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IModelNameProvider
Public Class FromHeaderAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IFromHeaderMetadata, IModelNameProvider
Inheritance
FromHeaderAttribute
Attributes
Implements

Examples

In this example, the value of the 'User-Agent' header is bound to the parameter.

app.MapGet("/user-agent", ([FromHeader(Name = "User-Agent")] string userAgent)
 => userAgent);

Remarks

Binds a parameter or property to the value of the request header with the same name, or the name specified in the Name property. Note that HTTP header names are case-insensitive, so the header name is matched without regard to case.

For more information about parameter binding see Parameter binding.

Constructors

Name Description
FromHeaderAttribute()

Properties

Name Description
BindingSource

Gets the BindingSource.
Name

The request header name.

Applies to

Feedback

Was this page helpful?