IFormFeature Interface

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Http.Features
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

Allows reading the request body as a HTTP form.

public interface class IFormFeature
public interface IFormFeature
type IFormFeature = interface
Public Interface IFormFeature
Derived

Properties

Form

Gets or sets the parsed form.

This API will return a non-null value if the request body was read using ReadFormAsync(CancellationToken) or ReadForm(), or if a value was explicitly assigned.

HasFormContentType

Indicates if the request has a supported form content-type.

Methods

ReadForm()

Parses the request body as a form.

If the request body has not been previously read, this API performs a synchronous (blocking) read on the HTTP input stream which may be unsupported or can adversely affect application performance. Consider using ReadFormAsync(CancellationToken) instead.

ReadFormAsync(CancellationToken)

Parses the request body as a form.

Applies to