CollectionModelBinder<TElement> Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.ModelBinding.Binders

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.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.0

Source:: CollectionModelBinder.cs

Source:: CollectionModelBinder.cs

Source:: CollectionModelBinder.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.

IModelBinder implementation for binding collection values.

generic <typename TElement>
public ref class CollectionModelBinder : Microsoft::AspNetCore::Mvc::ModelBinding::ICollectionModelBinder, Microsoft::AspNetCore::Mvc::ModelBinding::IModelBinder

public class CollectionModelBinder<TElement> : Microsoft.AspNetCore.Mvc.ModelBinding.ICollectionModelBinder, Microsoft.AspNetCore.Mvc.ModelBinding.IModelBinder

type CollectionModelBinder<'Element> = class
    interface ICollectionModelBinder
    interface IModelBinder

Public Class CollectionModelBinder(Of TElement)
Implements ICollectionModelBinder, IModelBinder

Type Parameters

TElement

Type of elements in the collection.

Inheritance: Object
CollectionModelBinder<TElement>

Derived: Microsoft.AspNetCore.Mvc.ModelBinding.Binders.ArrayModelBinder<TElement>

Microsoft.AspNetCore.Mvc.ModelBinding.Binders.DictionaryModelBinder<TKey,TValue>

Implements: ICollectionModelBinder IModelBinder

Constructors

CollectionModelBinder<TElement>(IModelBinder, ILoggerFactory, Boolean, MvcOptions)	Creates a new CollectionModelBinder<TElement>.
CollectionModelBinder<TElement>(IModelBinder, ILoggerFactory, Boolean)	Creates a new CollectionModelBinder<TElement>.
CollectionModelBinder<TElement>(IModelBinder, ILoggerFactory)	Creates a new CollectionModelBinder<TElement>.
CollectionModelBinder<TElement>(IModelBinder)	Obsolete. This constructor is obsolete and will be removed in a future version. The recommended alternative is the overload that also takes an ILoggerFactory. Creates a new CollectionModelBinder<TElement>.

Properties

ElementBinder	Gets the IModelBinder instances for binding collection elements.
Logger	The ILogger used for logging in this binder.

Methods

AddErrorIfBindingRequired(ModelBindingContext)	Add a ModelError to ModelState if IsBindingRequired.
BindModelAsync(ModelBindingContext)	Attempts to bind a model.
CanCreateInstance(Type)	Gets an indication whether or not this ICollectionModelBinder implementation can create an Object assignable to `targetType`.
ConvertToCollectionType(Type, IEnumerable<TElement>)	Gets an Object assignable to `targetType` that contains members from `collection`.
CopyToModel(Object, IEnumerable<TElement>)	Adds values from `sourceCollection` to given `target`.
CreateEmptyCollection(Type)	Create an Object assignable to `targetType`.
CreateInstance(Type)	Create an instance of `targetType`.

Applies to

Product	Versions
ASP.NET Core	1.0, 1.1, 2.0, 2.1, 2.2, 3.0, 3.1, 5.0, 6.0, 7.0, 8.0, 9.0

Share via