Angular Form Methods
This section describes members used to manipulate a widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
beginUpdate()
Prevents the widget from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the widget from excessive updates when you are changing multiple widget settings at once. After the beginUpdate() method is called, the widget does not update its UI until the endUpdate() method is called.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
defaultOptions(rule)
Specifies the device-dependent default configuration options for this component.
The component's default device options.
defaultOptions is a static method that the widget class supports. The following code demonstrates how to specify default options for all instances of the Form widget in an application executed on the desktop.
jQuery
DevExpress.ui.dxForm.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form options } });
Angular
import Form from "devextreme/ui/form"; // ... export class AppComponent { constructor () { Form.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form options } }); } }
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 options } }); export default { components: { DxForm } } </script>
React
import React from "react"; import dxForm from "devextreme/ui/form"; import Form from "devextreme-react/form"; class App extends React.Component { render () { dxForm.defaultOptions({ device: { deviceType: "desktop" }, options: { // Here go the Form options } }) return ( <div> <Form id="form1" /> <Form id="form2" /> </div> ) } } export default App;
dispose()
Disposes of all the resources allocated to the Form instance.
After calling this method, remove the DOM element associated with the widget:
$("#myForm").dxForm("dispose"); $("#myForm").remove();
Use this method only if the widget 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 widget element.
An HTML element or a jQuery element when you use jQuery.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
focus()
Sets focus on the widget.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
- Change Options at Runtime - Editor Options
getInstance(element)
Gets the instance of a widget found using its DOM node.
The widget's instance.
getInstance is a static method that the widget 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 widget's instance. Use it to access other methods of the widget.
This widget's instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
itemOption(id)
Gets a form item's configuration.
The form item's configuration.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
itemOption(id, option, value)
Updates the value of a single item option.
The following code shows how to call this method for an item organized in a group:
$(function () { var 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);
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
itemOption(id, options)
Updates the values of several item options.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName)
Detaches all event handlers from a single event.
The event's name.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
Detaches a particular event handler from a single event.
The object for which this method is called.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Subscribes to an event.
The object for which this method is called.
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Subscribes to events.
Events with their handlers: { "eventName1": handler1, "eventName2": handler2, ...}
The object for which this method is called.
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option()
Gets all widget options.
The widget's options.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName)
Gets the value of a single option.
The option's name or full path.
This option's value.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(optionName, optionValue)
Updates the value of a single option.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
option(options)
Updates the values of several options.
Options with their new values.
See Also
- Get and Set Options
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
repaint()
Repaints the widget without reloading data. Call it to update the widget's markup.
See Also
- reload() in DataSource | List
- refresh() in DataGrid | TreeList
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetOption(optionName)
Resets an option to its default value.
An option's name.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
resetValues()
Resets the editor's value to undefined.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
This method does not replace the formData object. To replace it, use the option(optionName, optionValue) method as shown below:
formInstance.option("formData", newFormData);
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateData(dataField, value)
Updates a formData field and the corresponding editor.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
updateDimensions()
Updates the dimensions of the widget contents.
A Promise that is resolved after the update is completed. It is a native Promise or a jQuery.Promise when you use jQuery.
Use this method to fit the widget contents to the widget size after it (size) has been changed.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
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.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
If you have technical questions, please create a support ticket in the DevExpress Support Center.