Skip to main content

FormBuilder<T> Methods

A Form control.
Name Description
AccessKey(JS) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
AccessKey(String) Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option.
ActiveStateEnabled(JS) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
ActiveStateEnabled(Boolean) Specifies whether the UI component changes its visual state as a result of user interaction. Mirrors the client-side activeStateEnabled option.
AlignItemLabels(JS) Specifies whether all item labels are aligned. Applies only to labels outside their editors (see labelMode). Mirrors the client-side alignItemLabels option.
AlignItemLabels(Boolean) Specifies whether all item labels are aligned. Applies only to labels outside their editors (see labelMode). Mirrors the client-side alignItemLabels option.
AlignItemLabelsInAllGroups(JS) Specifies whether item labels in all groups are aligned. Applies only to labels outside their editors (see labelMode). Mirrors the client-side alignItemLabelsInAllGroups option.
AlignItemLabelsInAllGroups(Boolean) Specifies whether item labels in all groups are aligned. Applies only to labels outside their editors (see labelMode). Mirrors the client-side alignItemLabelsInAllGroups option.
ColCount(JS) The count of columns in the form layout. Mirrors the client-side colCount option.
ColCount(Mode) The count of columns in the form layout. Mirrors the client-side colCount option.
ColCount(Int32) The count of columns in the form layout. Mirrors the client-side colCount option.
ColCountByScreen(Action<FormColCountByScreenBuilder>) Specifies dependency between the screen factor and the count of columns in the form layout. Mirrors the client-side colCountByScreen object.
CustomizeItem(RazorBlock) Specifies a function that customizes a form item after it has been created. Mirrors the client-side customizeItem option.
CustomizeItem(String) Specifies a function that customizes a form item after it has been created. Mirrors the client-side customizeItem option.
Disabled(JS) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
Disabled(Boolean) Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option.
ElementAttr(JS) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Dictionary<String, Object>) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
ElementAttr(String, Object) Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
FocusStateEnabled(JS) Specifies whether the UI component can be focused using keyboard navigation. Mirrors the client-side focusStateEnabled option.
FocusStateEnabled(Boolean) Specifies whether the UI component can be focused using keyboard navigation. Mirrors the client-side focusStateEnabled option.
FormData(Object) Provides the Form's data. Gets updated every time form fields change. Mirrors the client-side formData option.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
Height(JS) Specifies the UI component's height. Mirrors the client-side height option.
Height(Double) Specifies the UI component's height. Mirrors the client-side height option.
Height(String) Specifies the UI component's height. Mirrors the client-side height option.
Hint(JS) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
Hint(String) Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option.
HoverStateEnabled(JS) Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option.
HoverStateEnabled(Boolean) Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option.
ID(JS) Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
ID(String) Specifies the id attribute for the control’s HTML element.
IsDirty(JS)
IsDirty(Boolean)
Items(Action<FormItemsFactory<T>>) Holds an array of form items. Mirrors the client-side items object.
LabelLocation(FormLabelLocation) Specifies the location of a label against the editor. Applies only to labels outside their editors (see labelMode). Mirrors the client-side labelLocation option.
LabelMode(FormLabelMode)
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MinColWidth(JS) The minimum column width used for calculating column count in the form layout. Applies only if colCount property is 'auto'. Mirrors the client-side minColWidth option.
MinColWidth(Double) The minimum column width used for calculating column count in the form layout. Applies only if colCount property is 'auto'. Mirrors the client-side minColWidth option.
OnContentReady(RazorBlock) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnContentReady(String) A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option.
OnDisposing(RazorBlock) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnDisposing(String) A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option.
OnEditorEnterKey(RazorBlock) A function that is executed when the Enter key has been pressed while an editor is focused. Mirrors the client-side onEditorEnterKey option.
OnEditorEnterKey(String) A function that is executed when the Enter key has been pressed while an editor is focused. Mirrors the client-side onEditorEnterKey option.
OnFieldDataChanged(RazorBlock) A function that is executed when the value of a formData object field is changed. Mirrors the client-side onFieldDataChanged option.
OnFieldDataChanged(String) A function that is executed when the value of a formData object field is changed. Mirrors the client-side onFieldDataChanged option.
OnInitialized(RazorBlock) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnInitialized(String) A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option.
OnOptionChanged(RazorBlock) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
OnOptionChanged(String) A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option.
Option(String, Object) Specifies an option by its name.
OptionalMark(JS) The text displayed for optional fields. Applies only if showOptionalMark is true. Mirrors the client-side optionalMark option.
OptionalMark(String) The text displayed for optional fields. Applies only if showOptionalMark is true. Mirrors the client-side optionalMark option.
ReadOnly(JS) Specifies whether all editors on the form are read-only. Applies only to non-templated items. Mirrors the client-side readOnly option.
ReadOnly(Boolean) Specifies whether all editors on the form are read-only. Applies only to non-templated items. Mirrors the client-side readOnly option.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Render() Inherited from WidgetBuilder.
RequiredMark(JS) The text displayed for required fields. Mirrors the client-side requiredMark option.
RequiredMark(String) The text displayed for required fields. Mirrors the client-side requiredMark option.
RequiredMessage(JS) Specifies the message that is shown for end-users if a required field value is not specified. Mirrors the client-side requiredMessage option.
RequiredMessage(String) Specifies the message that is shown for end-users if a required field value is not specified. Mirrors the client-side requiredMessage option.
RtlEnabled(JS) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
RtlEnabled(Boolean) Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option.
ScreenByWidth(RazorBlock) Specifies a function that categorizes screens by their width. Mirrors the client-side screenByWidth option.
ScreenByWidth(String) Specifies a function that categorizes screens by their width. Mirrors the client-side screenByWidth option.
ScrollingEnabled(JS) A Boolean value specifying whether to enable or disable form scrolling. Mirrors the client-side scrollingEnabled option.
ScrollingEnabled(Boolean) A Boolean value specifying whether to enable or disable form scrolling. Mirrors the client-side scrollingEnabled option.
ShowColonAfterLabel(JS) Specifies whether a colon is displayed at the end of form labels. Applies only to labels outside their editors (see labelMode). Mirrors the client-side showColonAfterLabel option.
ShowColonAfterLabel(Boolean) Specifies whether a colon is displayed at the end of form labels. Applies only to labels outside their editors (see labelMode). Mirrors the client-side showColonAfterLabel option.
ShowOptionalMark(JS) Specifies whether or not the optional mark is displayed for optional fields. Mirrors the client-side showOptionalMark option.
ShowOptionalMark(Boolean) Specifies whether or not the optional mark is displayed for optional fields. Mirrors the client-side showOptionalMark option.
ShowRequiredMark(JS) Specifies whether or not the required mark is displayed for required fields. Mirrors the client-side showRequiredMark option.
ShowRequiredMark(Boolean) Specifies whether or not the required mark is displayed for required fields. Mirrors the client-side showRequiredMark option.
ShowValidationSummary(JS) Specifies whether or not the total validation summary is displayed on the form. Mirrors the client-side showValidationSummary option.
ShowValidationSummary(Boolean) Specifies whether or not the total validation summary is displayed on the form. Mirrors the client-side showValidationSummary option.
TabIndex(JS) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
TabIndex(Int32) Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option.
ToString() Inherited from WidgetBuilder.
ToTemplate() Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder.
ValidationGroup(JS) Gives a name to the internal validation group. Mirrors the client-side validationGroup option.
ValidationGroup(String) Gives a name to the internal validation group. Mirrors the client-side validationGroup option.
Visible(JS) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Visible(Boolean) Specifies whether the UI component is visible. Mirrors the client-side visible option.
Width(JS) Mirrors the client-side width option.
Width(Double) Mirrors the client-side width option.
Width(String) Mirrors the client-side width option.
See Also