FromQueryAttribute 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:: FromQueryAttribute.cs

Source:: FromQueryAttribute.cs

Source:: FromQueryAttribute.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 query string.

public ref class FromQueryAttribute : 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 FromQueryAttribute : 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 FromQueryAttribute : Attribute, Microsoft.AspNetCore.Http.Metadata.IFromQueryMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IBindingSourceMetadata, Microsoft.AspNetCore.Mvc.ModelBinding.IModelNameProvider

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

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

Public Class FromQueryAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IModelNameProvider

Public Class FromQueryAttribute
Inherits Attribute
Implements IBindingSourceMetadata, IFromQueryMetadata, IModelNameProvider

Inheritance: Attribute
FromQueryAttribute

Attributes: AttributeUsageAttribute

Implements: IBindingSourceMetadata IModelNameProvider IFromQueryMetadata

Examples

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

app.MapGet("/version", ([FromQuery(Name = "api-version")] string apiVersion)
    => apiVersion);

Remarks

Binds a parameter or property to the value of query string parameter with the same name, or the name specified in the Name property. The query parameter name is matched case-insensitively.

For more information about parameter binding see Parameter binding.

Constructors

FromQueryAttribute()

Properties

BindingSource	Gets the BindingSource.
Name	The name of the query string field.

Applies to

Share via