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: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
defaultOptions(rule)
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 } }); } }
dispose()
The following code disposes of an Form instance that corresponds to the element ID (or reference variable in Angular) and removes the element from the DOM:
jQuery
$("#myForm").dxForm("dispose"); $("#myForm").remove();
Angular
<dx-form #formVar id="myForm"></dx-form>
import { ..., ViewChild } from "@angular/core"; import { DxFormComponent } from "devextreme-angular"; // ... export class AppComponent { @ViewChild("formVar") form: DxFormComponent; removeForm (e) { this.form.instance.dispose(); document.getElementById("myForm").remove(); } }
endUpdate()
Refreshes the widget after a call of the beginUpdate() method.
Main article: beginUpdate()
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
getEditor(dataField)
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: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
- Change Options at Runtime - Editor Options
getInstance(element)
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
itemOption(id, option, value)
The following code shows how to call this method for an item organized 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"); });
form.itemOption("Contacts.phone", "visible", false)
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
registerKeyHandler(key, handler)
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: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
updateDimensions()
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: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
validate()
Validates the values of all editors on the form against the list of the validation rules specified for each form item.
The returned object contains the following fields:
isValid: Boolean
Indicates whether all the rules checked for the group are satisfied.brokenRules: Array
Rules that failed to pass the check. Their structure is described in the Validation Rules section.validators: Array
Validator widgets included in the validated group.
See Also
- Call Methods: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
If you have technical questions, please create a support ticket in the DevExpress Support Center.