Form

The Form widget represents fields of a data object as a collection of label-editor pairs. These pairs can be arranged in several groups, tabs and columns.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/form
Export: default
Form interactive configuration
Copy Code
Copy to Codepen
$("#form").dxForm({
});

                    

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    JavaScript
    <div id="form"></div>
    var companyData = {
        id: 1,
        name: "Super Mart of the West",
        city: "Bentonville",
        state: "Arkansas",
        zip: 72716,
        phone: "(800) 555-2797",
        fax: "(800) 555-2171",
        website: "http://www.nowebsite.com"
    };
    $(function () {
        $("#form").dxForm({
            formData: companyData,
            items: [
                'name', {
                    itemType: 'group',
                    caption: 'Location',
                    items: ['city', 'state', 'zip']
                }, {
                    itemType: 'group',
                    caption: 'Contacts',
                    items: ['phone', 'fax', 'website']
                }
            ]
        });
    });
  • Angular

    HTML
    JavaScript
    <dx-form
        [formData]="companyData">
        <dxi-item datafield="name"></dxi-item>
        <dxi-item
            itemType="group"
            caption="Location">
            <dxi-item dataField="city"></dxi-item>
            <dxi-item dataField="state"></dxi-item>
            <dxi-item dataField="zip"></dxi-item>
        </dxi-item>
        <dxi-item
            itemType="group"
            caption="Contacts">
            <dxi-item dataField="phone"></dxi-item>
            <dxi-item dataField="fax"></dxi-item>
            <dxi-item dataField="website"></dxi-item>
        </dxi-item>
    </dx-form>
    export class AppComponent {
        companyData = {
            id: 1,
            name: "Super Mart of the West",
            city: "Bentonville",
            state: "Arkansas",
            zip: 72716,
            phone: "(800) 555-2797",
            fax: "(800) 555-2171",
            website: "http://www.nowebsite.com"
        };
    }
  • AngularJS

    HTML
    JavaScript
    <div ng-controller="DemoController">
        <div dx-form="{
            formData: companyData,
            items: [
                'name', {
                    itemType: 'group',
                    caption: 'Location',
                    items: ['city', 'state', 'zip']
                }, {
                    itemType: 'group',
                    caption: 'Contacts',
                    items: ['phone', 'fax', 'website']
                }
            ]
        }"></div>
    </div>
    angular.module('DemoApp', ['dx'])
        .controller("DemoController", function ($scope) {
            $scope.companyData = {
                id: 1,
                name: "Super Mart of the West",
                city: "Bentonville",
                state: "Arkansas",
                zip: 72716,
                phone: "(800) 555-2797",
                fax: "(800) 555-2171",
                website: "http://www.nowebsite.com"
            };
        });
  • Knockout

    HTML
    JavaScript
    <div data-bind="dxForm: {
        formData: companyData,
        items: [
            'name', {
                itemType: 'group',
                caption: 'Location',
                items: ['city', 'state', 'zip']
            }, {
                itemType: 'group',
                caption: 'Contacts',
                items: ['phone', 'fax', 'website']
            }
        ]
    }"></div>
    var viewModel = {
        companyData: {
            id: 1,
            name: "Super Mart of the West",
            city: "Bentonville",
            state: "Arkansas",
            zip: 72716,
            phone: "(800) 555-2797",
            fax: "(800) 555-2171",
            website: "http://www.nowebsite.com"
        }
    };
    ko.applyBindings(viewModel);
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().Form()
        .FormData(new {
            id = 1,
            name = "Super Mart of the West",
            city = "Bentonville",
            state = "Arkansas",
            zip = 727161232,
            phone = "(800) 555-2797",
            fax = "(800) 555-2171",
            website = "http://www.nowebsite.com"
        })
        .Items(formItems => {
            formItems.AddSimple().DataField("name");
            formItems.AddGroup().Caption("Location").Items(locationItems => {
                locationItems.AddSimple().DataField("city");
                locationItems.AddSimple().DataField("state");
                locationItems.AddSimple().DataField("zip");
            });
            formItems.AddGroup().Caption("Contacts").Items(contactsItems => {
                contactsItems.AddSimple().DataField("phone");
                contactsItems.AddSimple().DataField("fax");
                contactsItems.AddSimple().DataField("website");
            });
        })
    )
    @(Html.DevExtreme().Form() _
        .FormData(New With {
            .id = 1,
            .name = "Super Mart of the West",
            .city = "Bentonville",
            .state = "Arkansas",
            .zip = 727161232,
            .phone = "(800) 555-2797",
            .fax = "(800) 555-2171",
            .website = "http://www.nowebsite.com"
        }) _
        .Items(Sub(formItems)
            formItems.AddSimple().DataField("name")
            formItems.AddGroup().Caption("Location").Items(Sub(locationItems)
                locationItems.AddSimple().DataField("city")
                locationItems.AddSimple().DataField("state")
                locationItems.AddSimple().DataField("zip")
            End Sub)
            formItems.AddGroup().Caption("Contacts").Items(Sub(contactsItems)
                contactsItems.AddSimple().DataField("phone")
                contactsItems.AddSimple().DataField("fax")
                contactsItems.AddSimple().DataField("website")
            End Sub)
        End Sub)
    )  

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

See Also

Configuration

An object defining configuration options for the Form widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

alignItemLabels

Specifies whether or not all root item labels are aligned.

alignItemLabelsInAllGroups

Specifies whether or not item labels in all groups are aligned.

colCount

The count of columns in the form layout.

colCountByScreen

Specifies dependency between the screen factor and the count of columns in the form layout.

customizeItem

Specifies a function that customizes a form item after it has been created.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

elementAttr

Specifies the attributes to be attached to the widget's root element.

focusStateEnabled

Specifies whether or not the widget can be focused.

formData

An object providing data for the form.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

items

Holds an array of form items.

labelLocation

Specifies the location of a label against the editor.

minColWidth

The minimum column width used for calculating column count in the form layout.

onContentReady

A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

onDisposing

A handler for the disposing event.

onEditorEnterKey

A handler for the editorEnterKey event.

onFieldDataChanged

A handler for the fieldDataChanged event.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

onOptionChanged

A handler for the optionChanged event.

optionalMark

The text displayed for optional fields.

readOnly

Specifies whether all editors on the form are read-only. Applies only to non-templated items.

requiredMark

The text displayed for required fields.

requiredMessage

Specifies the message that is shown for end-users if a required field value is not specified.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

screenByWidth

Specifies the function returning the screen factor depending on the screen width.

scrollingEnabled

A Boolean value specifying whether to enable or disable form scrolling.

showColonAfterLabel

Specifies whether or not a colon is displayed at the end of form labels.

showOptionalMark

Specifies whether or not the optional mark is displayed for optional fields.

showRequiredMark

Specifies whether or not the required mark is displayed for required fields.

showValidationSummary

Specifies whether or not the total validation summary is displayed on the form.

tabIndex

Specifies the widget tab index.

validationGroup

Gives a name to the internal validation group.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate a widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

focus()

Sets focus on the widget.

getEditor(field)

Returns an editor instance associated with the specified formData field or name of the form item.

instance()

Returns an instance of this component class.

itemOption(field)

Gets the value of the form item option.

itemOption(field, option, value)

Updates the value of a form item option.

itemOption(field, options)

Updates the values of form item options.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

resetValues()

Resets the editor's value to undefined.

updateData(data)

Updates the specified fields of the formData object and the corresponding editors on the form.

updateData(dataField, value)

Updates the specified field of the formData object and the corresponding editor on the form.

updateDimensions()

Updates the dimensions of the widget contents.

validate()

Validates the values of all editors on the form against the list of the validation rules specified for each form item.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.

disposing

Fires when the widget is being removed.

editorEnterKey

Fires after a user presses the Enter key when an editor is focused.

fieldDataChanged

Fires after the value of a formData object field has been changed.

initialized

Raised only once, after the widget is initialized.

optionChanged

Fires after an option of the component is changed.

Item Types

This section describes item types available in the Form widget.