AjaxExtensions.BeginForm Method (AjaxHelper, String, Object, AjaxOptions, Object)
Writes an opening <form> tag to the response.
Namespace: System.Web.Mvc.Ajax
Assembly: System.Web.Mvc (in System.Web.Mvc.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function BeginForm ( _
ajaxHelper As AjaxHelper, _
actionName As String, _
routeValues As Object, _
ajaxOptions As AjaxOptions, _
htmlAttributes As Object _
) As MvcForm
public static MvcForm BeginForm(
this AjaxHelper ajaxHelper,
string actionName,
Object routeValues,
AjaxOptions ajaxOptions,
Object htmlAttributes
)
[ExtensionAttribute]
public:
static MvcForm^ BeginForm(
AjaxHelper^ ajaxHelper,
String^ actionName,
Object^ routeValues,
AjaxOptions^ ajaxOptions,
Object^ htmlAttributes
)
Parameters
- ajaxHelper
Type: System.Web.Mvc.AjaxHelper
The AJAX helper.
- actionName
Type: System.String
The name of the action method that will handle the request.
- 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.
- ajaxOptions
Type: System.Web.Mvc.Ajax.AjaxOptions
An object that provides options for the asynchronous request.
- 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 AjaxHelper. 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).
Remarks
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 form is submitted asynchronously by using JavaScript.
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 = "form1", accept-charset="iso-8859-1" }
New With { .id = "form1", .accept-charset="iso-8859-1" }