Freigeben über


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)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function BeginRouteForm ( _
    ajaxHelper As AjaxHelper, _
    routeName As String, _
    routeValues As RouteValueDictionary, _
    ajaxOptions As AjaxOptions, _
    htmlAttributes As IDictionary(Of String, Object) _
) As MvcForm
public static MvcForm BeginRouteForm(
    this AjaxHelper ajaxHelper,
    string routeName,
    RouteValueDictionary routeValues,
    AjaxOptions ajaxOptions,
    IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcForm^ BeginRouteForm(
    AjaxHelper^ ajaxHelper, 
    String^ routeName, 
    RouteValueDictionary^ routeValues, 
    AjaxOptions^ ajaxOptions, 
    IDictionary<String^, Object^>^ htmlAttributes
)

Parameters

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

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

See Also

Reference

AjaxExtensions Class

BeginRouteForm Overload

System.Web.Mvc.Ajax Namespace