AjaxExtensions.BeginRouteForm Method (AjaxHelper, String, Object, 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, _
routeValues As Object, _
ajaxOptions As AjaxOptions _
) As MvcForm
public static MvcForm BeginRouteForm(
this AjaxHelper ajaxHelper,
string routeName,
Object routeValues,
AjaxOptions ajaxOptions
)
[ExtensionAttribute]
public:
static MvcForm^ BeginRouteForm(
AjaxHelper^ ajaxHelper,
String^ routeName,
Object^ routeValues,
AjaxOptions^ 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.
- 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.
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.