text-area.d.ts 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter } from '@angular/core';
  15. import DxTextArea from 'devextreme/ui/text_area';
  16. import { ControlValueAccessor } from '@angular/forms';
  17. import { DxComponent } from '../core/component';
  18. import { DxTemplateHost } from '../core/template-host';
  19. import { NestedOptionHost } from '../core/nested-option';
  20. import { WatcherHelper } from '../core/watcher-helper';
  21. /**
  22. * The TextArea is a widget that enables a user to enter and edit a multi-line text.
  23. */
  24. export declare class DxTextAreaComponent extends DxComponent implements OnDestroy, ControlValueAccessor {
  25. instance: DxTextArea;
  26. /**
  27. * Specifies the shortcut key that sets focus on the widget.
  28. */
  29. accessKey: string;
  30. /**
  31. * Specifies whether or not the widget changes its state when interacting with a user.
  32. */
  33. activeStateEnabled: boolean;
  34. /**
  35. * A Boolean value specifying whether or not the auto resizing mode is enabled.
  36. */
  37. autoResizeEnabled: boolean;
  38. /**
  39. * Specifies whether the widget responds to user interaction.
  40. */
  41. disabled: boolean;
  42. /**
  43. * Specifies the attributes to be attached to the widget's root element.
  44. */
  45. elementAttr: any;
  46. /**
  47. * Specifies whether the widget can be focused using keyboard navigation.
  48. */
  49. focusStateEnabled: boolean;
  50. /**
  51. * Specifies the widget's height.
  52. */
  53. height: number | Function | string;
  54. /**
  55. * Specifies text for a hint that appears when a user pauses on the widget.
  56. */
  57. hint: string;
  58. /**
  59. * Specifies whether the widget changes its state when a user pauses on it.
  60. */
  61. hoverStateEnabled: boolean;
  62. /**
  63. * Specifies the attributes to be passed on to the underlying HTML element.
  64. */
  65. inputAttr: any;
  66. /**
  67. * Specifies whether the editor's value is valid.
  68. */
  69. isValid: boolean;
  70. /**
  71. * Specifies the maximum height of the widget.
  72. */
  73. maxHeight: number | string;
  74. /**
  75. * Specifies the maximum number of characters you can enter into the textbox.
  76. */
  77. maxLength: number | string;
  78. /**
  79. * Specifies the minimum height of the widget.
  80. */
  81. minHeight: number | string;
  82. /**
  83. * The value to be assigned to the `name` attribute of the underlying HTML element.
  84. */
  85. name: string;
  86. /**
  87. * The text displayed by the widget when the widget value is empty.
  88. */
  89. placeholder: string;
  90. /**
  91. * Specifies whether the editor is read-only.
  92. */
  93. readOnly: boolean;
  94. /**
  95. * Switches the widget to a right-to-left representation.
  96. */
  97. rtlEnabled: boolean;
  98. /**
  99. * Specifies whether or not the widget checks the inner text for spelling mistakes.
  100. */
  101. spellcheck: boolean;
  102. /**
  103. * Specifies how the widget's text field is styled.
  104. */
  105. stylingMode: string;
  106. /**
  107. * Specifies the number of the element when the Tab key is used for navigating.
  108. */
  109. tabIndex: number;
  110. /**
  111. * The read-only option that holds the text displayed by the widget input element.
  112. */
  113. text: string;
  114. /**
  115. * Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
  116. */
  117. validationError: any;
  118. /**
  119. * Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
  120. */
  121. validationMessageMode: string;
  122. /**
  123. * Specifies a value the widget displays.
  124. */
  125. value: string;
  126. /**
  127. * Specifies the DOM events after which the widget's value should be updated.
  128. */
  129. valueChangeEvent: string;
  130. /**
  131. * Specifies whether the widget is visible.
  132. */
  133. visible: boolean;
  134. /**
  135. * Specifies the widget's width.
  136. */
  137. width: number | Function | string;
  138. /**
  139. * A function that is executed when the widget loses focus after the text field's content was changed using the keyboard.
  140. */
  141. onChange: EventEmitter<any>;
  142. /**
  143. * A function that is executed when the widget's content is ready and each time the content is changed.
  144. */
  145. onContentReady: EventEmitter<any>;
  146. /**
  147. * A function that is executed when the widget's input has been copied.
  148. */
  149. onCopy: EventEmitter<any>;
  150. /**
  151. * A function that is executed when the widget's input has been cut.
  152. */
  153. onCut: EventEmitter<any>;
  154. /**
  155. * A function that is executed before the widget is disposed of.
  156. */
  157. onDisposing: EventEmitter<any>;
  158. /**
  159. * A function that is executed when the Enter key has been pressed while the widget is focused.
  160. */
  161. onEnterKey: EventEmitter<any>;
  162. /**
  163. * A function that is executed when the widget gets focus.
  164. */
  165. onFocusIn: EventEmitter<any>;
  166. /**
  167. * A function that is executed when the widget loses focus.
  168. */
  169. onFocusOut: EventEmitter<any>;
  170. /**
  171. * A function used in JavaScript frameworks to save the widget instance.
  172. */
  173. onInitialized: EventEmitter<any>;
  174. /**
  175. * A function that is executed each time the widget's input is changed while the widget is focused.
  176. */
  177. onInput: EventEmitter<any>;
  178. /**
  179. * A function that is executed when a user is pressing a key on the keyboard.
  180. */
  181. onKeyDown: EventEmitter<any>;
  182. /**
  183. * A function that is executed when a user presses a key on the keyboard.
  184. */
  185. onKeyPress: EventEmitter<any>;
  186. /**
  187. * A function that is executed when a user releases a key on the keyboard.
  188. */
  189. onKeyUp: EventEmitter<any>;
  190. /**
  191. * A function that is executed after a widget option is changed.
  192. */
  193. onOptionChanged: EventEmitter<any>;
  194. /**
  195. * A function that is executed when the widget's input has been pasted.
  196. */
  197. onPaste: EventEmitter<any>;
  198. /**
  199. * A function that is executed after the widget's value is changed.
  200. */
  201. onValueChanged: EventEmitter<any>;
  202. /**
  203. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  204. */
  205. accessKeyChange: EventEmitter<string>;
  206. /**
  207. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  208. */
  209. activeStateEnabledChange: EventEmitter<boolean>;
  210. /**
  211. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  212. */
  213. autoResizeEnabledChange: EventEmitter<boolean>;
  214. /**
  215. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  216. */
  217. disabledChange: EventEmitter<boolean>;
  218. /**
  219. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  220. */
  221. elementAttrChange: EventEmitter<any>;
  222. /**
  223. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  224. */
  225. focusStateEnabledChange: EventEmitter<boolean>;
  226. /**
  227. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  228. */
  229. heightChange: EventEmitter<number | Function | string>;
  230. /**
  231. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  232. */
  233. hintChange: EventEmitter<string>;
  234. /**
  235. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  236. */
  237. hoverStateEnabledChange: EventEmitter<boolean>;
  238. /**
  239. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  240. */
  241. inputAttrChange: EventEmitter<any>;
  242. /**
  243. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  244. */
  245. isValidChange: EventEmitter<boolean>;
  246. /**
  247. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  248. */
  249. maxHeightChange: EventEmitter<number | string>;
  250. /**
  251. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  252. */
  253. maxLengthChange: EventEmitter<number | string>;
  254. /**
  255. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  256. */
  257. minHeightChange: EventEmitter<number | string>;
  258. /**
  259. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  260. */
  261. nameChange: EventEmitter<string>;
  262. /**
  263. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  264. */
  265. placeholderChange: EventEmitter<string>;
  266. /**
  267. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  268. */
  269. readOnlyChange: EventEmitter<boolean>;
  270. /**
  271. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  272. */
  273. rtlEnabledChange: EventEmitter<boolean>;
  274. /**
  275. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  276. */
  277. spellcheckChange: EventEmitter<boolean>;
  278. /**
  279. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  280. */
  281. stylingModeChange: EventEmitter<string>;
  282. /**
  283. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  284. */
  285. tabIndexChange: EventEmitter<number>;
  286. /**
  287. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  288. */
  289. textChange: EventEmitter<string>;
  290. /**
  291. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  292. */
  293. validationErrorChange: EventEmitter<any>;
  294. /**
  295. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  296. */
  297. validationMessageModeChange: EventEmitter<string>;
  298. /**
  299. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  300. */
  301. valueChange: EventEmitter<string>;
  302. /**
  303. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  304. */
  305. valueChangeEventChange: EventEmitter<string>;
  306. /**
  307. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  308. */
  309. visibleChange: EventEmitter<boolean>;
  310. /**
  311. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  312. */
  313. widthChange: EventEmitter<number | Function | string>;
  314. onBlur: EventEmitter<any>;
  315. change(_: any): void;
  316. touched: (_: any) => void;
  317. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  318. protected _createInstance(element: any, options: any): DxTextArea;
  319. writeValue(value: any): void;
  320. setDisabledState(isDisabled: boolean): void;
  321. registerOnChange(fn: (_: any) => void): void;
  322. registerOnTouched(fn: () => void): void;
  323. _createWidget(element: any): void;
  324. ngOnDestroy(): void;
  325. }
  326. export declare class DxTextAreaModule {
  327. }