Export (0) Print
Expand All

FormExtensions.BeginForm Method (HtmlHelper, String, String, RouteValueDictionary)

Writes an opening <form> tag to the response, and sets the action tag to the specified controller, action, and route values from the route value dictionary. The form uses the POST method.

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

public static MvcForm BeginForm(
	this HtmlHelper htmlHelper,
	string actionName,
	string controllerName,
	RouteValueDictionary routeValues
)

Parameters

htmlHelper
Type: System.Web.Mvc.HtmlHelper
The HTML helper instance that this method extends.
actionName
Type: System.String
The name of the action method.
controllerName
Type: System.String
The name of the controller.
routeValues
Type: System.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route.

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 http://msdn.microsoft.com/en-us/library/bb384936.aspx or http://msdn.microsoft.com/en-us/library/bb383977.aspx.

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.

The following example shows how to use this form of the method.

@{
    var routeValues = new RouteValueDictionary();
    routeValues.Add("UserId", "5");
}
@using (Html.BeginForm("Login", "Account", routeValues))
{
    @Html.TextBox("Name");
    @Html.Password("Password");
    <input type="submit" value="Sign In">
}
// Produces the following form element
// <form action="/Account/Login?UserId=5" action="post">
Show:
© 2014 Microsoft