FormExtensions.BeginForm Method (HtmlHelper, String, String, 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)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function BeginForm ( _
    htmlHelper As HtmlHelper, _
    actionName As String, _
    controllerName As String, _
    method As FormMethod, _
    htmlAttributes As Object _
) As MvcForm
'Usage
Dim htmlHelper As HtmlHelper 
Dim actionName As String 
Dim controllerName As String 
Dim method As FormMethod 
Dim htmlAttributes As Object 
Dim returnValue As MvcForm 

returnValue = htmlHelper.BeginForm(actionName, _
    controllerName, method, htmlAttributes)
public static MvcForm BeginForm(
    this HtmlHelper htmlHelper,
    string actionName,
    string controllerName,
    FormMethod method,
    Object htmlAttributes
)
[ExtensionAttribute]
public:
static MvcForm^ BeginForm(
    HtmlHelper^ htmlHelper, 
    String^ actionName, 
    String^ controllerName, 
    FormMethod method, 
    Object^ htmlAttributes
)
static member BeginForm : 
        htmlHelper:HtmlHelper * 
        actionName:string * 
        controllerName:string * 
        method:FormMethod * 
        htmlAttributes:Object -> MvcForm
public static function BeginForm(
    htmlHelper : HtmlHelper, 
    actionName : String, 
    controllerName : String, 
    method : FormMethod, 
    htmlAttributes : Object
) : MvcForm

Parameters

  • htmlAttributes
    Type: System.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 https://msdn.microsoft.com/en-us/library/bb384936(v=vs.108) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).

Remarks

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” }

See Also

Reference

FormExtensions Class

BeginForm Overload

System.Web.Mvc.Html Namespace