ApiBehaviorOptions.AllowInferringBindingSourceForCollectionTypesAsFromQuery Property

Definition

Namespace:

Microsoft.AspNetCore.Mvc

Assembly:

Microsoft.AspNetCore.Mvc.Core.dll

Package:

Microsoft.AspNetCore.Mvc.Core v2.2.0

Source:

ApiBehaviorOptions.cs

Gets or sets a value that determines if BindingSource for collection types (IsCollectionType).

When true, the binding source for collection types is inferred as Query. Otherwise Body is inferred.

public:
 property bool AllowInferringBindingSourceForCollectionTypesAsFromQuery { bool get(); void set(bool value); };

public bool AllowInferringBindingSourceForCollectionTypesAsFromQuery { get; set; }

member this.AllowInferringBindingSourceForCollectionTypesAsFromQuery : bool with get, set

Public Property AllowInferringBindingSourceForCollectionTypesAsFromQuery As Boolean

Property Value

Boolean

The default value is false if the version is Version_2_2 or later; true otherwise.

Remarks

This property is associated with a compatibility switch and can provide a different behavior depending on the configured compatibility version for the application. See CompatibilityVersion for guidance and examples of setting the application's compatibility version.

Configuring the desired value of the compatibility switch by calling this property's setter takes precedence over the value implied by the application's CompatibilityVersion.

If the application's compatibility version is set to Version_2_1 or lower then this setting will have the value true unless explicitly configured.

If the application's compatibility version is set to Version_2_2 or higher then this setting will have the value false unless explicitly configured.