AjaxExtensions.BeginRouteForm Method (AjaxHelper, String, AjaxOptions)

Writes an opening <form> tag to the response using the specified routing information.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function BeginRouteForm ( _
	ajaxHelper As AjaxHelper, _
	routeName As String, _
	ajaxOptions As AjaxOptions _
) As MvcForm
'Usage
Dim ajaxHelper As AjaxHelper 
Dim routeName As String 
Dim ajaxOptions As AjaxOptions 
Dim returnValue As MvcForm 

returnValue = ajaxHelper.BeginRouteForm(routeName, _
	ajaxOptions)

Parameters

ajaxHelper: Type: System.Web.Mvc.AjaxHelper
The AJAX helper.

routeName: Type: System.String
The name of the route to use to obtain the form post URL.

ajaxOptions: Type: System.Web.Mvc.Ajax.AjaxOptions
An object that provides options for the asynchronous request.

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 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.

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.