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

FormExtensions.BeginRouteForm Method (HtmlHelper, String, Object)

Writes an opening <form> tag to the response. When the user submits the form, the request will be processed by the route target.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function BeginRouteForm ( _
	htmlHelper As HtmlHelper, _
	routeName As String, _
	routeValues As Object _
) As MvcForm
'Usage
Dim htmlHelper As HtmlHelper 
Dim routeName As String 
Dim routeValues As Object 
Dim returnValue As MvcForm 

returnValue = htmlHelper.BeginRouteForm(routeName, _
	routeValues)

Parameters

htmlHelper
Type: System.Web.Mvc.HtmlHelper

The HTML helper instance that this method extends.

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.

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

The BeginForm method renders a form that will be handled by a controller action method.

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.

Show:
© 2015 Microsoft