IHtmlGenerator.GenerateForm Method

Definition

Namespace:

Microsoft.AspNetCore.Mvc.ViewFeatures

Assembly:

Microsoft.AspNetCore.Mvc.ViewFeatures.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

IHtmlGenerator.cs

Generate a <form> element. When the user submits the form, the action with name actionName will process the request.

public:
 Microsoft::AspNetCore::Mvc::Rendering::TagBuilder ^ GenerateForm(Microsoft::AspNetCore::Mvc::Rendering::ViewContext ^ viewContext, System::String ^ actionName, System::String ^ controllerName, System::Object ^ routeValues, System::String ^ method, System::Object ^ htmlAttributes);

public Microsoft.AspNetCore.Mvc.Rendering.TagBuilder GenerateForm (Microsoft.AspNetCore.Mvc.Rendering.ViewContext viewContext, string actionName, string controllerName, object routeValues, string method, object htmlAttributes);

abstract member GenerateForm : Microsoft.AspNetCore.Mvc.Rendering.ViewContext * string * string * obj * string * obj -> Microsoft.AspNetCore.Mvc.Rendering.TagBuilder

Public Function GenerateForm (viewContext As ViewContext, actionName As String, controllerName As String, routeValues As Object, method As String, htmlAttributes As Object) As TagBuilder

Parameters

viewContext

ViewContext

A ViewContext instance for the current scope.

actionName

String

The name of the action method.

controllerName

String

The name of the controller.

routeValues

Object

An Object that contains the parameters for a route. The parameters are retrieved through reflection by examining the properties of the Object. This Object is typically created using Object initializer syntax. Alternatively, an IDictionary<TKey,TValue> instance containing the route parameters.

method

String

The HTTP method for processing the form, either GET or POST.

htmlAttributes

Object

An Object that contains the HTML attributes for the element. Alternatively, an IDictionary<TKey,TValue> instance containing the HTML attributes.

Returns

TagBuilder

A TagBuilder instance for the </form> element.