Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
BeginRouteForm Method (AjaxHelper, String, RouteValueDictionary, AjaxOptions, IDictionary(String, Object))

AjaxExtensions.BeginRouteForm Method (AjaxHelper, String, RouteValueDictionary, AjaxOptions, IDictionary<String, Object>)

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)

public static MvcForm BeginRouteForm(
	this AjaxHelper ajaxHelper,
	string routeName,
	RouteValueDictionary routeValues,
	AjaxOptions ajaxOptions,
	IDictionary<string, Object> htmlAttributes
)

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.Web.Routing.RouteValueDictionary

An object that contains the parameters for a route.

ajaxOptions
Type: System.Web.Mvc.Ajax.AjaxOptions

An object that provides options for the asynchronous request.

htmlAttributes
Type: System.Collections.Generic.IDictionary<String, 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 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.

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" }
Show:
© 2015 Microsoft