Configuration

An object defining configuration options for the Form widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type:

String

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies whether or not the widget changes its state when interacting with a user.

Type:

Boolean

Default Value: false

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

alignItemLabels

Specifies whether or not all root item labels are aligned.

Type:

Boolean

Default Value: true
Show Example:
AngularJS
Knockout
jQuery

alignItemLabelsInAllGroups

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

Type:

Boolean

Default Value: true
NOTE
This option applies only to those simple items that are nested within a group item. Thus, we recommend that you do not leave any simple items ungrouped if you need a consistent alignment throughout the Form.
Show Example:
AngularJS
Knockout
jQuery

colCount

The count of columns in the form layout.

Type:

Number

|

String

Default Value: 1
Accepted Values: 'auto'
NOTE

For extra small screens, this option always equals 1 to make the widget adaptive. To override this logic, specify the colCountByScreen option.

jQuery
JavaScript
$(function() {
    $("#formContainer").dxForm({
        // ...
        colCountByScreen: {
            xs: 2
        }
    });
});
Angular
HTML
TypeScript
<dx-form ... >
    <dxo-col-count-by-screen [xs]="2"></dxo-col-count-by-screen>
</dx-form>
import { DxFormModule } from 'devextreme-angular';
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxFormModule
    ],
    // ...
})

When using the widget as an ASP.NET MVC Control, you can specify this option using the Mode enum that accepts the value Auto.

See Also
Show Example:
AngularJS
Knockout
jQuery

colCountByScreen

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

Type:

Object

Default Value: undefined

customizeItem

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

Type:

function

Function parameters:

Provides access to the item instance.

If you did not define form items using the items option, the Form widget creates them automatically according to the structure of an object passed to the formData option. The customizeItem option enables you to modify options of each generated item before this item is rendered. Each generated item passed to this function as an argument has a Simple Item structure.

If the items option contains definition for form items, you usually do not need to pass a function to the customizeItem option because you can customize items before passing them to the items option. However, if you assign a function to this option, it will be called for each item. In this case, an item can have structure corresponding to any of the following item types.

  • Simple
    A standard item consisting of a label and an editor widget used to specify a value of the associated data field.

  • Group
    An item representing a container of other form items.

  • Tabbed
    An item representing a tabbed container of other form items.

  • Empty
    An empty item used to add a space between neighboring form items.

See Also

disabled

Specifies whether the widget responds to user interaction.

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

elementAttr

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

Type:

Object

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Boolean

Default Value: false

formData

An object providing data for the form.

Type:

Object

Default Value: {}

height

Specifies the widget's height.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget height.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The height of the widget in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type:

String

Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type:

Boolean

Default Value: false

items

Holds an array of form items.

The array passed to this option can hold items of the following types.

  • Simple
    A standard item consisting of a label and an editor widget used to specify a value of the associated data field.

  • Group
    An item representing a container of another form items.

  • Tabbed
    An item representing a tabbed container of another form items.

  • Empty
    An empty item used to add a space between neighboring items.

When using the widget as an ASP.NET MVC Control, declare the items in the following manner.

Razor C#
Razor VB
@(Html.DevExtreme().Form()
    .FormData(Model.Data)
    .Items(rootItems => {
        rootItems.AddSimple().DataField("EmployeeID"); // Adds a simple item
        rootItems.AddEmpty(); // Adds an empty item
        rootItems.AddGroup().Caption("General Info") // Adds a group item
            .Items(groupItems => {
                groupItems.AddSimple().DataField("FirstName");
                // ...
            });
        rootItems.AddTabbed() // Adds a tabbed item
            .Tabs(tabs => {
                tabs.Add().Title("Address")
                    .Items(addressItems => {
                        addressItems.AddSimple().DataField("Country");
                        // ...
                    });
                tabs.Add().Title("Phone")
                    // ...
            });
    })
)
@(Html.DevExtreme().Form() _
    .FormData(Model.Data) _
    .Items(Sub(rootItems)
        rootItems.AddSimple().DataField("EmployeeID") ' Adds a simple item
        rootItems.AddEmpty() ' Adds an empty item
        ' Adds a group item
        rootItems.AddGroup().Caption("General Info") _
            .Items(Sub(groupItems)
                groupItems.AddSimple().DataField("FirstName")
                ' ...
            End Sub)
        ' Adds a tabbed item
        rootItems.AddTabbed() _
            .Tabs(Sub(tabs)
                tabs.Add().Title("Address") _
                    .Items(Sub(addressItems)
                        addressItems.AddSimple().DataField("Country")
                        ' ...
                    End Sub)
                tabs.Add().Title("Phone")
                    ' ...
            End Sub)
    End Sub)
)
Show Example:
AngularJS
Knockout
jQuery

labelLocation

Specifies the location of a label against the editor.

Type:

String

Default Value: 'left'
Accepted Values: 'left' | 'right' | 'top'

When using the widget as an ASP.NET MVC Control, specify this option using the FormLabelLocation enum. This enum accepts the following values: Left, Right and Top.

See Also
Show Example:
AngularJS
Knockout
jQuery

minColWidth

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

Type:

Number

Default Value: 200

This option makes sense only if the colCount option is set to 'auto'.

NOTE
The actual column width equals the widget width divided by the column count.
Show Example:
AngularJS
Knockout
jQuery

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.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the widget's instance.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

Default Value: null

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

onEditorEnterKey

A handler for the editorEnterKey event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the form instance.

element:

Element (jQuery or HTML)

The form's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

dataField:

String

The path to the formData object field associated with the current editor.

Default Value: null

Assign a function to perform a custom action after a user presses the Enter key when an editor is focused.

onFieldDataChanged

A handler for the fieldDataChanged event.

Type:

function

Function parameters:
e:

Object

Provides function parameters.

Object structure:
component:

Object

Provides access to the form instance.

element:

Element (jQuery or HTML)

The form's container.

model:

Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

dataField:

String

The path to the formData object field whose value has been changed.

value:

Object

The new value of the field.

Default Value: null

Assign a function to perform a custom action after the value of a formData object field has been changed.

See Also
Show Example:
AngularJS
Knockout
jQuery

onInitialized

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

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

element:

Element (jQuery or HTML)

The widget's container.

Default Value: null

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

function

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

The widget's container.

model:

Object

The model data. Available only if you use Knockout.

Default Value: null

optionalMark

The text displayed for optional fields.

Type:

String

Default Value: 'optional'
See Also
Show Example:
AngularJS
Knockout
jQuery

readOnly

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

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

requiredMark

The text displayed for required fields.

Type:

String

Default Value: '*'
See Also
Show Example:
AngularJS
Knockout
jQuery

requiredMessage

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

Type:

String

Default Value: '{0} is required'

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Boolean

Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

screenByWidth

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

Type:

function

Default Value: null

The function passed to this option should take on the screen width as a parameter and return a string containing the appropriate screen factor.

jQuery
JavaScript
$(function() {
    $("#formContainer").dxForm({
        // ...
        screenByWidth: function(width) {
            if (width < 768) return 'xs';
            if (width < 992) return 'sm';
            if (width < 1200) return 'md';
            return 'lg';
        }
    });
});
Angular
HTML
TypeScript
<dx-form ...
    [screenByWidth]="getSizeQualifier">
</dx-form>
import { DxFormModule } from 'devextreme-angular';
// ...
export class AppComponent {
    // ...
    getSizeQualifier (width) {
        if (width < 768)  return "xs";
        if (width < 992)  return "sm";
        if (width < 1200) return "md";
        return "lg";
    }
}
@NgModule({
    imports: [
        // ...
        DxFormModule
    ],
    // ...
})

View Demo

scrollingEnabled

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

Type:

Boolean

Default Value: false

Show Example:
AngularJS
Knockout
jQuery

showColonAfterLabel

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

Type:

Boolean

Default Value: true

showOptionalMark

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

Type:

Boolean

Default Value: false
See Also
Show Example:
AngularJS
Knockout
jQuery

showRequiredMark

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

Type:

Boolean

Default Value: true
See Also
Show Example:
AngularJS
Knockout
jQuery

showValidationSummary

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

Type:

Boolean

Default Value: false

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

validationGroup

Gives a name to the internal validation group.

Type:

String

Default Value: undefined

In some cases, the Form editors should be validated by the Button widget. By default, these editors are collected in an unnamed validation group, what makes it impossible for the Button to validate them. In this case, give this validation group a name using the validationGroup option of the Form widget. Also, pass the same name to the validationGroup option of the Button widget.

$(function () {
    $("#formContainer").dxForm({
        // ...
        validationGroup: "groupName"
    });

    $("#buttonContainer").dxButton({
        // ...
        validationGroup: "groupName",
        onClick: function (e) {
            e.validationGroup.validate();
        }
    });
})

visible

Specifies whether the widget is visible.

Type:

Boolean

Default Value: true

width

Specifies the widget's width.

Type:

Number

|

String

|

function

Return Value:

Number

|

String

The widget width.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The width of the widget in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }
NOTE

Even if the width of the widget is specified, the count of columns may depend on the screen width. For example, if the screen width is not enough to display the whole form's container, the count of columns depends on the screen width, not the container. To always use a fixed count of columns regardless of the screen width, pass an empty function to the screenByWidth option.

JavaScript
screenByWidth: function() { }