FormExtensions.BeginRouteForm Method (HtmlHelper, String, RouteValueDictionary, FormMethod, IDictionary<String, Object>)

Visual Studio 2010

Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target.

Namespace:  System.Web.Mvc.Html
Assembly:  System.Web.Mvc (in System.Web.Mvc.dll)

public static MvcForm BeginRouteForm(
	this HtmlHelper htmlHelper,
	string routeName,
	RouteValueDictionary routeValues,
	FormMethod method,
	IDictionary<string, Object> htmlAttributes


Type: System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
Type: System.String
The name of the route to use to obtain the form-post URL.
Type: System.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route
Type: System.Web.Mvc.FormMethod
The HTTP method for processing the form, either GET or POST.
Type: System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes to set for the element.

Return Value

Type: System.Web.Mvc.Html.MvcForm
An opening <form> tag.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type HtmlHelper. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

The BeginForm method renders a form that will be handled by a controller action method.

You can use this method in a using block. In that case, the method renders the closing </form> tag at the end of the using block.

Community Additions