FormExtensions.BeginRouteForm Method

Writes an opening form tag to the response.

Namespace: Kentico.Forms.Web.Mvc.Internal
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0

Syntax

public static UpdatableMvcForm BeginRouteForm(
	this ExtensionPoint<HtmlHelper> instance,
	string formId,
	string updateTargetId,
	string routeName = null,
	RouteValueDictionary routeValues = null,
	FormMethod formMethod = FormMethod.Post,
	IDictionary<string, Object> htmlAttributes = null
)

Parameters

instance

Type: Kentico.Web.Mvc.ExtensionPoint<HtmlHelper>
>HtmlHelper extension point.

formId

Type: System.String
Gets or sets element's ID for the form.

updateTargetId

Type: System.String
Gets or sets the ID of the DOM element to update by using the response from the server when form needs to be re-rendered e.g. due to the application of visibility condition.

routeName (Optional)

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

routeValues (Optional)

Type: System.Web.Routing.RouteValueDictionary
An object that contains the parameters for a route.

formMethod (Optional)

Type: FormMethod
Enumeration of the HTTP request types for a form.

htmlAttributes (Optional)

Type: System.Collections.Generic.IDictionary<String, Object>
An object that contains the HTML attributes to set for the element.

Return Value

Type: UpdatableMvcForm
Returns an object representing updatable form.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ExtensionPoint<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).

Exceptions

Exception	Condition
ArgumentNullException	Thrown when instance is null.
ArgumentException	Thrown when formId or updateTargetId is null or empty.
InvalidOperationException	Thrown when UpdatableMvcForm are nested.