FormExtensions.BeginRouteForm Method (HtmlHelper, String, RouteValueDictionary, FormMethod, IDictionary<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)
Syntax
'Declaration
<ExtensionAttribute> _
Public Shared Function BeginRouteForm ( _
htmlHelper As HtmlHelper, _
routeName As String, _
routeValues As RouteValueDictionary, _
method As FormMethod, _
htmlAttributes As IDictionary(Of String, Object) _
) As MvcForm
public static MvcForm BeginRouteForm(
this HtmlHelper htmlHelper,
string routeName,
RouteValueDictionary routeValues,
FormMethod method,
IDictionary<string, Object> htmlAttributes
)
[ExtensionAttribute]
public:
static MvcForm^ BeginRouteForm(
HtmlHelper^ htmlHelper,
String^ routeName,
RouteValueDictionary^ routeValues,
FormMethod method,
IDictionary<String^, Object^>^ htmlAttributes
)
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.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route
- method
Type: System.Web.Mvc.FormMethod
The HTTP method for processing the form, either GET or POST.
- 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 HtmlHelper. 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
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.