FormExtensions.BeginForm Method (HtmlHelper, String, String, Object, FormMethod, Object)
Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by an action method.
Namespace: System.Web.Mvc.Html
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
'Declaration <ExtensionAttribute> _ Public Shared Function BeginForm ( _ htmlHelper As HtmlHelper, _ actionName As String, _ controllerName As String, _ routeValues As Object, _ method As FormMethod, _ htmlAttributes As Object _ ) As MvcForm 'Usage Dim htmlHelper As HtmlHelper Dim actionName As String Dim controllerName As String Dim routeValues As Object Dim method As FormMethod Dim htmlAttributes As Object Dim returnValue As MvcForm returnValue = htmlHelper.BeginForm(actionName, _ controllerName, routeValues, method, _ htmlAttributes)
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.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 by using object initializer syntax.
- method
- Type: System.Web.Mvc.FormMethod
The HTTP method for processing the form, either GET or POST.
- htmlAttributes
- Type: System.Object
An object that contains the HTML attributes to set for the element.
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 https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108).aspx or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).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 htmlAttributes parameter consists of an object that contains name/value pairs. The attributes that are specified in the name/value pairs depend on the HTML element that is being rendered. For example, for a form element, you might provide the following anonymous object:
new { id = “text1”, accept-charset=”iso-8859-1” }
New With { .id = “text1”, .accept-charset=”iso-8859-1” }