ParameterBinder.BindModelAsync Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ModelBinding

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

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

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.

Overloads

BindModelAsync(ActionContext, IValueProvider, ParameterDescriptor)	Obsolete. This method overload is obsolete and will be removed in a future version. The recommended alternative is BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object). Initializes and binds a model specified by `parameter`.
BindModelAsync(ActionContext, IValueProvider, ParameterDescriptor, Object)	Obsolete. This method overload is obsolete and will be removed in a future version. The recommended alternative is BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object). Binds a model specified by `parameter` using `value` as the initial value.
BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object)	Binds a model specified by `parameter` using `value` as the initial value.
BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object, Object)	Binds a model specified by `parameter` using `value` as the initial value.

BindModelAsync(ActionContext, IValueProvider, ParameterDescriptor)

Source:: ParameterBinder.cs

Source:: ParameterBinder.cs

Caution

This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder, ModelMetadata and Object parameters.

This method overload is obsolete and will be removed in a future version. The recommended alternative is BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object).

Initializes and binds a model specified by parameter.

public:
 System::Threading::Tasks::Task<Microsoft::AspNetCore::Mvc::ModelBinding::ModelBindingResult> ^ BindModelAsync(Microsoft::AspNetCore::Mvc::ActionContext ^ actionContext, Microsoft::AspNetCore::Mvc::ModelBinding::IValueProvider ^ valueProvider, Microsoft::AspNetCore::Mvc::Abstractions::ParameterDescriptor ^ parameter);

public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter);

[System.Obsolete("This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder, ModelMetadata and Object parameters.")]
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter);

member this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

[<System.Obsolete("This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder, ModelMetadata and Object parameters.")>]
member this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

Public Function BindModelAsync (actionContext As ActionContext, valueProvider As IValueProvider, parameter As ParameterDescriptor) As Task(Of ModelBindingResult)

Parameters

actionContext: ActionContext

The ActionContext.

valueProvider: IValueProvider

The IValueProvider.

parameter: ParameterDescriptor

The ParameterDescriptor

Returns

Task<ModelBindingResult>

The result of model binding.

Attributes: ObsoleteAttribute

Applies to

BindModelAsync(ActionContext, IValueProvider, ParameterDescriptor, Object)

Source:: ParameterBinder.cs

Source:: ParameterBinder.cs

Caution

This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder and ModelMetadata parameters.

Binds a model specified by parameter using value as the initial value.

public:
 virtual System::Threading::Tasks::Task<Microsoft::AspNetCore::Mvc::ModelBinding::ModelBindingResult> ^ BindModelAsync(Microsoft::AspNetCore::Mvc::ActionContext ^ actionContext, Microsoft::AspNetCore::Mvc::ModelBinding::IValueProvider ^ valueProvider, Microsoft::AspNetCore::Mvc::Abstractions::ParameterDescriptor ^ parameter, System::Object ^ value);

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, object value);

[System.Obsolete("This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder and ModelMetadata parameters.")]
public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, object value);

abstract member BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>
override this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

[<System.Obsolete("This method overload is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes IModelBinder and ModelMetadata parameters.")>]
abstract member BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>
override this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

Public Overridable Function BindModelAsync (actionContext As ActionContext, valueProvider As IValueProvider, parameter As ParameterDescriptor, value As Object) As Task(Of ModelBindingResult)

Parameters

actionContext: ActionContext

The ActionContext.

valueProvider: IValueProvider

The IValueProvider.

parameter: ParameterDescriptor

The ParameterDescriptor

value: Object

The initial model value.

Returns

Task<ModelBindingResult>

The result of model binding.

Attributes: ObsoleteAttribute

Applies to

BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object)

Source:: ParameterBinder.cs

Source:: ParameterBinder.cs

Binds a model specified by parameter using value as the initial value.

public:
 virtual System::Threading::Tasks::Task<Microsoft::AspNetCore::Mvc::ModelBinding::ModelBindingResult> ^ BindModelAsync(Microsoft::AspNetCore::Mvc::ActionContext ^ actionContext, Microsoft::AspNetCore::Mvc::ModelBinding::IModelBinder ^ modelBinder, Microsoft::AspNetCore::Mvc::ModelBinding::IValueProvider ^ valueProvider, Microsoft::AspNetCore::Mvc::Abstractions::ParameterDescriptor ^ parameter, Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ metadata, System::Object ^ value);

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder modelBinder, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata metadata, object value);

public virtual System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder modelBinder, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata metadata, object? value);

abstract member BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>
override this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata * obj -> System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

Public Overridable Function BindModelAsync (actionContext As ActionContext, modelBinder As IModelBinder, valueProvider As IValueProvider, parameter As ParameterDescriptor, metadata As ModelMetadata, value As Object) As Task(Of ModelBindingResult)

Parameters

actionContext: ActionContext

The ActionContext.

modelBinder: IModelBinder

The IModelBinder.

valueProvider: IValueProvider

The IValueProvider.

parameter: ParameterDescriptor

The ParameterDescriptor

metadata: ModelMetadata

The ModelMetadata.

value: Object

The initial model value.

Returns

Task<ModelBindingResult>

The result of model binding.

Applies to

BindModelAsync(ActionContext, IModelBinder, IValueProvider, ParameterDescriptor, ModelMetadata, Object, Object)

Binds a model specified by parameter using value as the initial value.

public:
 virtual System::Threading::Tasks::ValueTask<Microsoft::AspNetCore::Mvc::ModelBinding::ModelBindingResult> BindModelAsync(Microsoft::AspNetCore::Mvc::ActionContext ^ actionContext, Microsoft::AspNetCore::Mvc::ModelBinding::IModelBinder ^ modelBinder, Microsoft::AspNetCore::Mvc::ModelBinding::IValueProvider ^ valueProvider, Microsoft::AspNetCore::Mvc::Abstractions::ParameterDescriptor ^ parameter, Microsoft::AspNetCore::Mvc::ModelBinding::ModelMetadata ^ metadata, System::Object ^ value, System::Object ^ container);

public virtual System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder modelBinder, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata metadata, object value, object container);

public virtual System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult> BindModelAsync (Microsoft.AspNetCore.Mvc.ActionContext actionContext, Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder modelBinder, Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider valueProvider, Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor parameter, Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata metadata, object? value, object? container);

abstract member BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata * obj * obj -> System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>
override this.BindModelAsync : Microsoft.AspNetCore.Mvc.ActionContext * Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder * Microsoft.AspNetCore.Mvc.ModelBinding.IValueProvider * Microsoft.AspNetCore.Mvc.Abstractions.ParameterDescriptor * Microsoft.AspNetCore.Mvc.ModelBinding.ModelMetadata * obj * obj -> System.Threading.Tasks.ValueTask<Microsoft.AspNetCore.Mvc.ModelBinding.ModelBindingResult>

Public Overridable Function BindModelAsync (actionContext As ActionContext, modelBinder As IModelBinder, valueProvider As IValueProvider, parameter As ParameterDescriptor, metadata As ModelMetadata, value As Object, container As Object) As ValueTask(Of ModelBindingResult)