InputForm

Defined in: js-api/src/widgets/forms.ts:199

A form with multiple inputs inside

Extends

• DartWrapper

Constructors

Constructor

new InputForm(dart): InputForm

Defined in: js-api/src/widgets/forms.ts:200

Parameters

Parameter	Type
dart	any

Returns

InputForm

Overrides

DartWrapper.constructor

Properties

Property	Type	Inherited from	Defined in
dart	any	DartWrapper.dart	js-api/src/widgets/base.ts:494

Accessors

inputs

Get Signature

get inputs(): InputBase<any>[]

Defined in: js-api/src/widgets/forms.ts:222

All inputs added to the form

Returns

InputBase<any>[]

---

isValid

Get Signature

get isValid(): boolean

Defined in: js-api/src/widgets/forms.ts:237

Returns true if all inputs are valid.

Returns

boolean

---

onFormPropertyChanged

Get Signature

get onFormPropertyChanged(): Observable<EventData<PropertyChangeArgs>>

Defined in: js-api/src/widgets/forms.ts:244

Fires when a property bound to the form via the property-grid path changes.

Returns

Observable<EventData<PropertyChangeArgs>>

---

onInputChanged

Get Signature

get onInputChanged(): Observable<EventData<InputArgs>>

Defined in: js-api/src/widgets/forms.ts:231

Occurs when user changes any input value in a form.

Returns

Observable<EventData<InputArgs>>

---

onValidationCompleted

Get Signature

get onValidationCompleted(): Observable<any>

Defined in: js-api/src/widgets/forms.ts:234

Occurs after the form is validated, no matter whether it is valid or not.

Returns

Observable<any>

---

root

Get Signature

get root(): HTMLElement

Defined in: js-api/src/widgets/forms.ts:217

Returns

HTMLElement

---

source

Get Signature

get source(): any

Defined in: js-api/src/widgets/forms.ts:226

Returns

any

Set Signature

set source(source): void

Defined in: js-api/src/widgets/forms.ts:228

Parameters

Parameter	Type
source	any

Returns

void

Methods

getInput()

getInput(propertyName): InputBase

Defined in: js-api/src/widgets/forms.ts:219

Parameters

Parameter	Type
propertyName	string

Returns

InputBase

---

validateInputs()

validateInputs(): boolean

Defined in: js-api/src/widgets/forms.ts:241

Runs validation across all inputs in the form. Returns true when every input is valid. Also updates isValid and fires onValidationCompleted.

Returns

boolean

---

forFuncCall()

static forFuncCall(funcCall, options?): Promise<InputForm>

Defined in: js-api/src/widgets/forms.ts:207

Creates an InputForm for the specified function call.

Parameters

Parameter	Type	Description
funcCall	FuncCall	-
options?	{ skipDefaultInit?: boolean; skipLogic?: boolean; skipTableAutoFill?: boolean; twoWayBinding?: boolean; }	-
options.skipDefaultInit?	boolean	-
options.skipLogic?	boolean	renders inputs and binds them to the call, nothing else: no default or auto-filled values, no choice or default functions, no validation, no visible/enabled expressions. The host sets values, items, visibility, enabled state and validation status itself. Implies skipDefaultInit and skipTableAutoFill.
options.skipTableAutoFill?	boolean	-
options.twoWayBinding?	boolean	-

Returns

Promise<InputForm>

---

forInputs()

static forInputs(inputs): InputForm

Defined in: js-api/src/widgets/forms.ts:212

Parameters

Parameter	Type
inputs	InputBase<any>[]

Returns

InputForm