/*! * devextreme-angular * Version: 19.1.16 * Build date: Tue Oct 18 2022 * * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import DxForm from 'devextreme/ui/form'; import { DxComponent } from '../core/component'; import { DxTemplateHost } from '../core/template-host'; import { NestedOptionHost } from '../core/nested-option'; import { WatcherHelper } from '../core/watcher-helper'; import { IterableDifferHelper } from '../core/iterable-differ-helper'; import { DxiItemComponent } from './nested/item-dxi'; /** * 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. */ export declare class DxFormComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxForm; /** * Specifies the shortcut key that sets focus on the widget. */ accessKey: string; /** * Specifies whether or not the widget changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether or not all root item labels are aligned. */ alignItemLabels: boolean; /** * Specifies whether or not item labels in all groups are aligned. */ alignItemLabelsInAllGroups: boolean; /** * The count of columns in the form layout. */ colCount: number | string; /** * Specifies dependency between the screen factor and the count of columns in the form layout. */ colCountByScreen: { lg?: number; md?: number; sm?: number; xs?: number; }; /** * Specifies a function that customizes a form item after it has been created. */ customizeItem: Function; /** * Specifies whether the widget responds to user interaction. */ disabled: boolean; /** * Specifies the attributes to be attached to the widget's root element. */ elementAttr: any; /** * Specifies whether the widget can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Provides the Form's data. Gets updated every time form fields change. */ formData: any; /** * Specifies the widget's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the widget. */ hint: string; /** * Specifies whether the widget changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Holds an array of form items. */ items: Array; /** * Specifies the location of a label against the editor. */ labelLocation: string; /** * The minimum column width used for calculating column count in the form layout. */ minColWidth: number; /** * The text displayed for optional fields. */ optionalMark: string; /** * Specifies whether all editors on the form are read-only. Applies only to non-templated items. */ readOnly: boolean; /** * The text displayed for required fields. */ requiredMark: string; /** * Specifies the message that is shown for end-users if a required field value is not specified. */ requiredMessage: string; /** * Switches the widget to a right-to-left representation. */ rtlEnabled: boolean; /** * Specifies a function that categorizes screens by their width. */ screenByWidth: Function; /** * A Boolean value specifying whether to enable or disable form scrolling. */ scrollingEnabled: boolean; /** * Specifies whether or not a colon is displayed at the end of form labels. */ showColonAfterLabel: boolean; /** * Specifies whether or not the optional mark is displayed for optional fields. */ showOptionalMark: boolean; /** * Specifies whether or not the required mark is displayed for required fields. */ showRequiredMark: boolean; /** * Specifies whether or not the total validation summary is displayed on the form. */ showValidationSummary: boolean; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Gives a name to the internal validation group. */ validationGroup: string; /** * Specifies whether the widget is visible. */ visible: boolean; /** * Specifies the widget's width. */ width: number | Function | string; /** * A function that is executed when the widget's content is ready and each time the content is changed. */ onContentReady: EventEmitter; /** * A function that is executed before the widget is disposed of. */ onDisposing: EventEmitter; /** * A function that is executed when the Enter key has been pressed while an editor is focused. */ onEditorEnterKey: EventEmitter; /** * A function that is executed when the value of a formData object field is changed. */ onFieldDataChanged: EventEmitter; /** * A function used in JavaScript frameworks to save the widget instance. */ onInitialized: EventEmitter; /** * A function that is executed after a widget option is changed. */ onOptionChanged: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ alignItemLabelsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ alignItemLabelsInAllGroupsChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ colCountChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ colCountByScreenChange: EventEmitter<{ lg?: number; md?: number; sm?: number; xs?: number; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ customizeItemChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ formDataChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ itemsChange: EventEmitter>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ labelLocationChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ minColWidthChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ optionalMarkChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ readOnlyChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ requiredMarkChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ requiredMessageChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ screenByWidthChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ scrollingEnabledChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showColonAfterLabelChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showOptionalMarkChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showRequiredMarkChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ showValidationSummaryChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ validationGroupChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter; itemsChildren: QueryList; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxForm; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxFormModule { }