AjaxHelperExtensionsBeginRouteForm Method |
Writes an opening form tag to the response.
Namespace: Kentico.Forms.Web.Mvc.InternalAssembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0
Syntax public static UpdatableMvcForm BeginRouteForm(
this ExtensionPoint<AjaxHelper> instance,
string formId,
AjaxOptions ajaxOptions,
string updateTargetId = null,
string routeName = null,
RouteValueDictionary routeValues = null,
IDictionary<string, Object> htmlAttributes = null
)
Parameters
- instance
- Type: Kentico.Web.MvcExtensionPointAjaxHelper
AjaxHelper extension point. - formId
- Type: SystemString
Gets or sets element's ID for the form. - ajaxOptions
- Type: AjaxOptions
An object that provides options for the asynchronous request. - updateTargetId (Optional)
- Type: SystemString
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.
- routeName (Optional)
- Type: SystemString
The name of the route to use to obtain the form post-URL. - routeValues (Optional)
- Type: System.Web.RoutingRouteValueDictionary
An object that contains the parameters for a route. - htmlAttributes (Optional)
- Type: System.Collections.GenericIDictionaryString, Object
An object that contains the HTML attributes to set for the element.
Return Value
Type:
UpdatableMvcFormReturns 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
ExtensionPointAjaxHelper. 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 See Also