Back to all docs
API Reference / Kendo.Mvc.UI.Fluent / FormBuilder<T>
New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

FormBuilder<T>

Class

Defines the fluent API for configuring the Kendo Form for ASP.NET MVC.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Type Parameters:

T

Syntax:
C#
public class FormBuilder<T> : WidgetBuilderBase<Form<T>, FormBuilder<T>>, IHtmlString where T : class

Inheritance: objectWidgetBuilderBase<Form<T>, FormBuilder<T>>FormBuilder<T>

Implements: IHtmlString

Inherited Members WidgetBuilderBase<Form<T>, FormBuilder<T>>.ToComponent()WidgetBuilderBase<Form<T>, FormBuilder<T>>.Name(string)WidgetBuilderBase<Form<T>, FormBuilder<T>>.Deferred(bool)WidgetBuilderBase<Form<T>, FormBuilder<T>>.ModelMetadata(ModelMetadata)WidgetBuilderBase<Form<T>, FormBuilder<T>>.HtmlAttributes(object)WidgetBuilderBase<Form<T>, FormBuilder<T>>.HtmlAttributes(IDictionary<string, object>)WidgetBuilderBase<Form<T>, FormBuilder<T>>.AsModule(bool)WidgetBuilderBase<Form<T>, FormBuilder<T>>.Render()WidgetBuilderBase<Form<T>, FormBuilder<T>>.ScriptAttributes(object, bool)WidgetBuilderBase<Form<T>, FormBuilder<T>>.ScriptAttributes(IDictionary<string, object>, bool)WidgetBuilderBase<Form<T>, FormBuilder<T>>.ToHtmlString()WidgetBuilderBase<Form<T>, FormBuilder<T>>.ToClientTemplate()WidgetBuilderBase<Form<T>, FormBuilder<T>>.ToString()WidgetBuilderBase<Form<T>, FormBuilder<T>>.Componentobject.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Constructors

FormBuilder(Form<T>)

Initializes a new instance of the Form class.

C#
public FormBuilder(Form<T> component)
Parameters:componentForm<T>

The component.

Methods

ButtonsTemplate(string)

Specifies the template which is used for rendering the Form buttons.

C#
public FormBuilder<T> ButtonsTemplate(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

FormBuilder<T>

ButtonsTemplate<TModel>(TemplateBuilder<TModel>)

Specifies the template which is used for rendering the Form buttons.

C#
public FormBuilder<T> ButtonsTemplate<TModel>(TemplateBuilder<TModel> template)
Parameters:templateTemplateBuilder<TModel>

A Template component that configures the buttonstemplate.

Returns:

FormBuilder<T>

ButtonsTemplateHandler(string)

Specifies the template which is used for rendering the Form buttons.

C#
public FormBuilder<T> ButtonsTemplateHandler(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

FormBuilder<T>

ButtonsTemplateId(string)

Specifies the template which is used for rendering the Form buttons.

C#
public FormBuilder<T> ButtonsTemplateId(string value)
Parameters:valuestring

The value that configures the buttonstemplate.

Returns:

FormBuilder<T>

ButtonsTemplateView(MvcHtmlString)

Specifies the template which is used for rendering the Form buttons.

C#
public FormBuilder<T> ButtonsTemplateView(MvcHtmlString value)
Parameters:valueMvcHtmlString

The value that configures the buttonstemplate.

Returns:

FormBuilder<T>

ClearButton(bool)

Specifies if the clearButton should be rendered on initialization.

C#
public FormBuilder<T> ClearButton(bool value)
Parameters:valuebool

The value that configures the clearbutton.

Returns:

FormBuilder<T>

Example:
C#
@(Html.Kendo().Form()
.Name("form")
.ClearButton(false)
)

Events(Action<FormEventBuilder>)

Configures the client-side events.

C#
public FormBuilder<T> Events(Action<FormEventBuilder> configurator)
Parameters:configuratorAction<FormEventBuilder>

The client events action.

Returns:

FormBuilder<T>

Example:
C#
@( Html.Kendo().Form()
.Name("Form")
.Events(events =&gt; events
.Validate("onValidate")
)
)

FocusFirst(bool)

Specifies if the first editor of the form will be focused on initialization.

C#
public FormBuilder<T> FocusFirst(bool value)
Parameters:valuebool

The value that configures the focusfirst.

Returns:

FormBuilder<T>

FormatLabel(Func<object, object>)

Callback function that could be used to change the default format of the automatically generated labels.

C#
public FormBuilder<T> FormatLabel(Func<object, object> handler)
Parameters:handlerFunc<object, object>

The value that configures the formatlabel action.

Returns:

FormBuilder<T>

Example:
C#
@(Html.Kendo().Form&lt;Kendo.Mvc.Examples.Models.Form.FormItemsViewModels&gt;()
.Name("form")
.FormatLabel(@&lt;text&gt;
function(field){
return field + ":";
}
&lt;/text&gt;)
)

FormatLabel(string)

Callback function that could be used to change the default format of the automatically generated labels.

C#
public FormBuilder<T> FormatLabel(string handler)
Parameters:handlerstring

The value that configures the formatlabel action.

Returns:

FormBuilder<T>

Example:
C#
@(Html.Kendo().Form&lt;Kendo.Mvc.Examples.Models.Form.FormItemsViewModels&gt;()
.Name("form")
.FormatLabel("formatLabelHandler")
)

FormData(object)

C#
public FormBuilder<T> FormData(object value)
Parameters:valueobjectReturns:

FormBuilder<T>

Grid(Action<FormGridSettingsBuilder<T>>)

Grid layout settings.

C#
public FormBuilder<T> Grid(Action<FormGridSettingsBuilder<T>> configurator)
Parameters:configuratorAction<FormGridSettingsBuilder<T>>

The action that configures the grid.

Returns:

FormBuilder<T>

Items(Action<FormItemFactory<T>>)

C#
public FormBuilder<T> Items(Action<FormItemFactory<T>> configurator)
Parameters:configuratorAction<FormItemFactory<T>>Returns:

FormBuilder<T>

Layout(string)

Specify the layout of Form content. Valid options are: grid: This is equivalent to display: grid. It defines the form element as a grid container and establishes a new grid formatting context for its contents..

C#
public FormBuilder<T> Layout(string value)
Parameters:valuestring

The value that configures the layout.

Returns:

FormBuilder<T>

Messages(Action<FormMessagesSettingsBuilder<T>>)

Configures text messages displayed in the Form. Use it to customize or localize the Form messages.

C#
public FormBuilder<T> Messages(Action<FormMessagesSettingsBuilder<T>> configurator)
Parameters:configuratorAction<FormMessagesSettingsBuilder<T>>

The action that configures the messages.

Returns:

FormBuilder<T>

Orientation(string)

Configures the Form orientation. Available options are "horizontal" and "vertical".By default, the Form is rendered with vertical orientation.

C#
public FormBuilder<T> Orientation(string value)
Parameters:valuestring

The value that configures the orientation.

Returns:

FormBuilder<T>

Size(ComponentSize)

Sets a value controlling the size of the input.

C#
public FormBuilder<T> Size(ComponentSize value)
Parameters:valueComponentSize

The value that configures the size.

Returns:

FormBuilder<T>

SmartPaste(Action<SmartPasteButtonBuilder>)

C#
public FormBuilder<T> SmartPaste(Action<SmartPasteButtonBuilder> configurator)
Parameters:configuratorAction<SmartPasteButtonBuilder>Returns:

FormBuilder<T>

Validatable(Action<FormValidatableSettingsBuilder<T>>)

Configures the built-in Validator options.

C#
public FormBuilder<T> Validatable(Action<FormValidatableSettingsBuilder<T>> configurator)
Parameters:configuratorAction<FormValidatableSettingsBuilder<T>>

The action that configures the validatable.

Returns:

FormBuilder<T>

In this article
DefinitionConstructorsFormBuilder(Form<T>)MethodsButtonsTemplate(string)ButtonsTemplate<TModel>(TemplateBuilder<TModel>)ButtonsTemplateHandler(string)ButtonsTemplateId(string)ButtonsTemplateView(MvcHtmlString)ClearButton(bool)Events(Action<FormEventBuilder>)FocusFirst(bool)FormatLabel(Func<object, object>)FormatLabel(string)FormData(object)Grid(Action<FormGridSettingsBuilder<T>>)Items(Action<FormItemFactory<T>>)Layout(string)Messages(Action<FormMessagesSettingsBuilder<T>>)Orientation(string)Size(ComponentSize)SmartPaste(Action<SmartPasteButtonBuilder>)Validatable(Action<FormValidatableSettingsBuilder<T>>)
Not finding the help you need?
Contact Support