AjaxExtensions.BeginForm Method (AjaxHelper, String, String, RouteValueDictionary, AjaxOptions)

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, _
    controllerName As String, _
    routeValues As RouteValueDictionary, _
    ajaxOptions As AjaxOptions _
) As MvcForm
'Usage
Dim ajaxHelper As AjaxHelper 
Dim actionName As String 
Dim controllerName As String 
Dim routeValues As RouteValueDictionary 
Dim ajaxOptions As AjaxOptions 
Dim returnValue As MvcForm 

returnValue = ajaxHelper.BeginForm(actionName, _
    controllerName, routeValues, ajaxOptions)
public static MvcForm BeginForm(
    this AjaxHelper ajaxHelper,
    string actionName,
    string controllerName,
    RouteValueDictionary routeValues,
    AjaxOptions ajaxOptions
)
[ExtensionAttribute]
public:
static MvcForm^ BeginForm(
    AjaxHelper^ ajaxHelper, 
    String^ actionName, 
    String^ controllerName, 
    RouteValueDictionary^ routeValues, 
    AjaxOptions^ ajaxOptions
)
static member BeginForm : 
        ajaxHelper:AjaxHelper * 
        actionName:string * 
        controllerName:string * 
        routeValues:RouteValueDictionary * 
        ajaxOptions:AjaxOptions -> MvcForm
public static function BeginForm(
    ajaxHelper : AjaxHelper, 
    actionName : String, 
    controllerName : String, 
    routeValues : RouteValueDictionary, 
    ajaxOptions : AjaxOptions
) : MvcForm

Parameters

  • actionName
    Type: System.String

    The name of the action method that will handle the 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) or https://msdn.microsoft.com/en-us/library/bb383977(v=vs.108).

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.

See Also

Reference

AjaxExtensions Class

BeginForm Overload

System.Web.Mvc.Ajax Namespace