IInputStatus
Defined in: js-api/src/widgets/base.ts:220
Live state of ONE named input of a widget, as reported by IWidgetStatus.inputs — the machine-readable counterpart of what the user sees in a form. Values and validation are read on demand, never cached: a widget reports whatever it holds at the moment Widget.getWidgetStatus is called.
name is the name the widget's properties address the input by, so
widget.props[status.name] = value writes exactly what typing into it would.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
caption? | string | Human-facing label. | js-api/src/widgets/base.ts:224 |
choices? | any[] | Allowed values, when the input is a closed vocabulary. | js-api/src/widgets/base.ts:231 |
description? | string | - | js-api/src/widgets/base.ts:237 |
error? | string | Validation message; absent while valid. | js-api/src/widgets/base.ts:236 |
name | string | Name of the input — also its property name in Widget.props. | js-api/src/widgets/base.ts:222 |
ref? | string | What a 'ref' value points at (a domain table address, 'User', 'Group'...). | js-api/src/widgets/base.ts:239 |
required | boolean | Whether an empty value is a validation error. | js-api/src/widgets/base.ts:233 |
semType? | string | - | js-api/src/widgets/base.ts:228 |
type | string | Value type: a TYPE name ('string', 'int', 'datetime'...), or 'ref' when the value addresses another object (see ref). | js-api/src/widgets/base.ts:227 |
valid | boolean | - | js-api/src/widgets/base.ts:234 |
value | any | - | js-api/src/widgets/base.ts:229 |