Angular Form Methods
This section describes members used to manipulate a UI component.
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
defaultOptions(rule)
Specifies the device-dependent default configuration properties for this component.
The component's default device properties.
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Form UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxForm.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form properties } });
Angular
import Form from "devextreme/ui/form"; // ... export class AppComponent { constructor () { Form.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form properties } }); } }
Vue
<template> <div> <DxForm id="form1" /> <DxForm id="form2" /> </div> </template> <script> import DxForm from "devextreme-vue/form"; import Form from "devextreme/ui/form"; Form.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form properties } }); export default { components: { DxForm } } </script>
React
import React, {useEffect} from "react"; import dxForm from "devextreme/ui/form"; import Form from "devextreme-react/form"; export default function App() { useEffect(() => { dxForm.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form properties } }) }); return ( <div> <Form id="form1" /> <Form id="form2" /> </div> ) }
dispose()
Disposes of all the resources allocated to the Form instance.
After calling this method, remove the DOM element associated with the UI component:
$("#myForm").dxForm("dispose"); $("#myForm").remove();
Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-form ... *ngIf="condition"> </dx-form>
Vue
<template> <DxForm ... v-if="condition"> </DxForm> </template> <script> import DxForm from 'devextreme-vue/form'; export default { components: { DxForm } } </script>
React
import React from 'react'; import Form from 'devextreme-react/form'; function DxForm(props) { if (!props.shouldRender) { return null; } return ( <Form ... > </Form> ); } class App extends React.Component { render() { return ( <DxForm shouldRender="condition" /> ); } } export default App;
See Also
element()
Gets the root UI component element.
An HTML element or a jQuery element when you use jQuery.
getEditor(dataField)
Gets an editor instance. Takes effect only if the form item is visible.
The editor instance.
The following code shows how to get an editor of an item in a group:
var form = $(function () { $("#formContainer").dxForm({ formData: { firstName: "John", lastName: "Heart", phone: "+1(213) 555-9392", email: "jheart@dx-email.com" }, items: ["firstName", "lastName", { itemType: "group", caption: "Contacts", items: ["phone", "email"] }] }).dxForm("instance"); $("#buttonContainer").dxButton({ text: "Customize Phone Editor", onClick: function (e) { var editor = form.getEditor("phone"); // Customizations go here } }); });
See Also
getInstance(element)
Gets the instance of a UI component found using its DOM node.
The UI component's instance.
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Form instance found in an element with the myForm
ID:
// Modular approach import Form from "devextreme/ui/form"; ... let element = document.getElementById("myForm"); let instance = Form.getInstance(element) as Form; // Non-modular approach let element = document.getElementById("myForm"); let instance = DevExpress.ui.dxForm.getInstance(element);
See Also
instance()
Gets the UI component's instance. Use it to access other methods of the UI component.
This UI component's instance.
itemOption(id)
Gets a form item's configuration.
The form item's configuration.
itemOption(id, option, value)
Updates the value of a single item property.
The following code shows how to call this method for an item organized in a group:
$(function () { const form = $("#formContainer").dxForm({ formData: { firstName: "John", lastName: "Heart", phone: "+1(213) 555-9392", email: "jheart@dx-email.com" }, items: ["firstName", "lastName", { itemType: "group", caption: "Contacts", name: "groupName", items: ["phone", "email"] }] }).dxForm("instance"); });
form.itemOption("groupName.phone", "visible", false); // ==== or ==== form.itemOption("Contacts.phone", "visible", false);
When you modify an item, the Form also refreshes all other items in its group. If an item is not in a group, the whole Form is refreshed. To update only your chosen items, wrap them into a separate group.
See Also
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
option(optionName)
Gets the value of a single property.
The property's name or full path.
This property's value.
option(options)
Updates the values of several properties.
Options with their new values.
registerKeyHandler(key, handler)
Registers a handler to be executed when a user presses a specific key.
A key.
A handler. Accepts the keydown event as the argument. It is a dxEvent or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
repaint()
Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)
Resets a property to its default value.
A property's name.
updateData(data)
Merges the passed data
object with formData. Matching properties in formData are overwritten and new properties added.
Data fields with their new values.
updateDimensions()
Updates the dimensions of the UI component contents.
A Promise that is resolved after the update is completed. It is a native Promise or a jQuery.Promise when you use jQuery.
validate()
Validates the values of all editors on the form against the list of the validation rules specified for each form item.
The validation result.
If you have technical questions, please create a support ticket in the DevExpress Support Center.