IFormCollection.Item[String] Property

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.Features.dll

Package:: Microsoft.AspNetCore.Http.Features v1.0.0

Package:: Microsoft.AspNetCore.Http.Features v1.1.0

Package:: Microsoft.AspNetCore.Http.Features v2.0.0

Package:: Microsoft.AspNetCore.Http.Features v2.1.0

Package:: Microsoft.AspNetCore.Http.Features v2.2.0

Package:: Microsoft.AspNetCore.Http.Features v3.0.3

Package:: Microsoft.AspNetCore.Http.Features v3.1.18

Package:: Microsoft.AspNetCore.Http.Features v5.0.9

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-rc.2.24474.3

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

Gets the value with the specified key.

public:
 property Microsoft::Extensions::Primitives::StringValues default[System::String ^] { Microsoft::Extensions::Primitives::StringValues get(System::String ^ key); };

public Microsoft.Extensions.Primitives.StringValues this[string key] { get; }

member this.Item(string) : Microsoft.Extensions.Primitives.StringValues

Default Public ReadOnly Property Item(key As String) As StringValues

Parameters

key: String

The key of the value to get.

Property Value

StringValues

The element with the specified key, or StringValues.Empty if the key is not present.

Exceptions

ArgumentNullException

key is null.

InvalidOperationException

incorrect content-type.

Remarks

IFormCollection has a different indexer contract than IDictionary<TKey,TValue>, as it will return StringValues.Empty for missing entries rather than throwing an Exception.

This indexer can only be used on POST requests. Otherwise an exception of type InvalidOperationException is thrown.

Invoking this property could result in thread exhaustion since it's wrapping an asynchronous implementation. The HttpRequest.ReadFormAsync(CancellationToken) method can get the form without blocking. For more information, see https://aka.ms/aspnet/forms-async.

Applies to

Share via