HtmlHelperFormExtensions.BeginRouteForm Method

Definition

Namespace:

Microsoft.AspNetCore.Mvc.Rendering

Assembly:

Microsoft.AspNetCore.Mvc.ViewFeatures.dll

Package:

Microsoft.AspNetCore.App.Ref v9.0.0

Overloads

BeginRouteForm(IHtmlHelper, String, FormMethod, Object)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, Object)	Renders a <form> start tag to the response. The first route that can provide a URL with the specified routeValues generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, String)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, Object, Nullable<Boolean>)	Renders a <form> start tag to the response. The first route that can provide a URL with the specified routeValues generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, String, FormMethod)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, String, Nullable<Boolean>)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, String, Object)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.
BeginRouteForm(IHtmlHelper, String, Object, FormMethod)	Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

BeginRouteForm(IHtmlHelper, String, FormMethod, Object)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName, Microsoft::AspNetCore::Mvc::Rendering::FormMethod method, System::Object ^ htmlAttributes);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName, Microsoft.AspNetCore.Mvc.Rendering.FormMethod method, object htmlAttributes);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string * Microsoft.AspNetCore.Mvc.Rendering.FormMethod * obj -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String, method As FormMethod, htmlAttributes As Object) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

method

FormMethod

The HTTP method for processing the form, either GET or POST.

htmlAttributes

Object

An Object that contains the HTML attributes for the element. Alternatively, an IDictionary<TKey,TValue> instance containing the HTML attributes.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, Object)

Renders a <form> start tag to the response. The first route that can provide a URL with the specified routeValues generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::Object ^ routeValues);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, object routeValues);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * obj -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeValues As Object) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeValues

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 using Object initializer syntax. Alternatively, an IDictionary<TKey,TValue> instance containing the route parameters.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, String)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, Object, Nullable<Boolean>)

Renders a <form> start tag to the response. The first route that can provide a URL with the specified routeValues generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::Object ^ routeValues, Nullable<bool> antiforgery);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, object routeValues, bool? antiforgery);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * obj * Nullable<bool> -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeValues As Object, antiforgery As Nullable(Of Boolean)) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeValues

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 using Object initializer syntax. Alternatively, an IDictionary<TKey,TValue> instance containing the route parameters.

antiforgery

Nullable<Boolean>

If true, <form> elements will include an antiforgery token. If false, suppresses the generation an <input> of type "hidden" with an antiforgery token. If null, <form> elements will include an antiforgery token.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, String, FormMethod)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName, Microsoft::AspNetCore::Mvc::Rendering::FormMethod method);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName, Microsoft.AspNetCore.Mvc.Rendering.FormMethod method);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string * Microsoft.AspNetCore.Mvc.Rendering.FormMethod -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String, method As FormMethod) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

method

FormMethod

The HTTP method for processing the form, either GET or POST.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, String, Nullable<Boolean>)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName, Nullable<bool> antiforgery);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName, bool? antiforgery);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string * Nullable<bool> -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String, antiforgery As Nullable(Of Boolean)) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

antiforgery

Nullable<Boolean>

If true, <form> elements will include an antiforgery token. If false, suppresses the generation an <input> of type "hidden" with an antiforgery token. If null, <form> elements will include an antiforgery token.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, String, Object)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName, System::Object ^ routeValues);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName, object routeValues);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string * obj -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String, routeValues As Object) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

routeValues

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 using Object initializer syntax. Alternatively, an IDictionary<TKey,TValue> instance containing the route parameters.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.

BeginRouteForm(IHtmlHelper, String, Object, FormMethod)

Renders a <form> start tag to the response. The route with name routeName generates the <form>'s action attribute value.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::AspNetCore::Mvc::Rendering::MvcForm ^ BeginRouteForm(Microsoft::AspNetCore::Mvc::Rendering::IHtmlHelper ^ htmlHelper, System::String ^ routeName, System::Object ^ routeValues, Microsoft::AspNetCore::Mvc::Rendering::FormMethod method);

public static Microsoft.AspNetCore.Mvc.Rendering.MvcForm BeginRouteForm (this Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper htmlHelper, string routeName, object routeValues, Microsoft.AspNetCore.Mvc.Rendering.FormMethod method);

static member BeginRouteForm : Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper * string * obj * Microsoft.AspNetCore.Mvc.Rendering.FormMethod -> Microsoft.AspNetCore.Mvc.Rendering.MvcForm

<Extension()>
Public Function BeginRouteForm (htmlHelper As IHtmlHelper, routeName As String, routeValues As Object, method As FormMethod) As MvcForm

Parameters

htmlHelper

IHtmlHelper

The IHtmlHelper instance this method extends.

routeName

String

The name of the route.

routeValues

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 using Object initializer syntax. Alternatively, an IDictionary<TKey,TValue> instance containing the route parameters.

method

FormMethod

The HTTP method for processing the form, either GET or POST.

Returns

MvcForm

An MvcForm instance which renders the </form> end tag when disposed.

Remarks

In this context, "renders" means the method writes its output using Writer.