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

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)


<ExtensionAttribute> _
Public Shared Function BeginRouteForm ( _
    htmlHelper As HtmlHelper, _
    routeName As String, _
    routeValues As RouteValueDictionary, _
    method As FormMethod, _
    htmlAttributes As IDictionary(Of String, Object) _
) As MvcForm
Dim htmlHelper As HtmlHelper 
Dim routeName As String 
Dim routeValues As RouteValueDictionary 
Dim method As FormMethod 
Dim htmlAttributes As IDictionary(Of String, Object)
Dim returnValue As MvcForm 

returnValue = htmlHelper.BeginRouteForm(routeName, _
    routeValues, method, htmlAttributes)
public static MvcForm BeginRouteForm(
    this HtmlHelper htmlHelper,
    string routeName,
    RouteValueDictionary routeValues,
    FormMethod method,
    IDictionary<string, Object> htmlAttributes
static MvcForm^ BeginRouteForm(
    HtmlHelper^ htmlHelper, 
    String^ routeName, 
    RouteValueDictionary^ routeValues, 
    FormMethod method, 
    IDictionary<String^, Object^>^ htmlAttributes
static member BeginRouteForm : 
        htmlHelper:HtmlHelper * 
        routeName:string * 
        routeValues:RouteValueDictionary * 
        method:FormMethod * 
        htmlAttributes:IDictionary<string, Object> -> MvcForm
public static function BeginRouteForm(
    htmlHelper : HtmlHelper, 
    routeName : String, 
    routeValues : RouteValueDictionary, 
    method : FormMethod, 
    htmlAttributes : IDictionary<String, Object>
) : MvcForm


  • routeName
    Type: System.String

    The name of the route to use to obtain the form-post URL.

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 or


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.

See Also


FormExtensions Class

BeginRouteForm Overload

System.Web.Mvc.Html Namespace