AjaxHelperExtensions.BeginForm 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 BeginForm(
	this ExtensionPoint<AjaxHelper> instance,
	string formId,
	AjaxOptions ajaxOptions,
	string updateTargetId = null,
	string actionName = null,
	string controllerName = null,
	RouteValueDictionary routeValues = null,
	IDictionary<string, Object> htmlAttributes = null
)

Parameters

instance

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

formId

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

ajaxOptions

Type: AjaxOptions
An object that provides options for the asynchronous request.

updateTargetId (Optional)

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. If null then 'ajaxOptions.UpdateTargetId' is used.

actionName (Optional)

Type: System.String
The name of the action method that will handle the request.

controllerName (Optional)

Type: System.String
The name of the controller that will handle the request.

routeValues (Optional)

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

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<AjaxHelper>. 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 is null or empty or both updateTargetId and UpdateTargetId() are null or empty.
InvalidOperationException	Thrown when UpdatableMvcForm are nested.