Phone API Reference - UI Extended - genericForm.setValue

Owned by Kelli Higdon
Last updated: Feb 28, 2024
1 min read

genericForm.setValue

 

Description

Sets the value of a specified object based on the 'setting' value you gave that object. Note: the form must be shown before setValue can be called.

Basic Example: 

genericForm.setValue(parameters);

Parameters

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

setting

Yes

string

 

Unique identifier used in the 'inputs' array when the genericForm.show() method is called.

value

Yes

varied

 

New value appropriate to the object

skipOnChange

No

boolean

false

Whether or not to execute the onchange callback (if one exists) for the input.

Examples

genericForm.setValue to set the value of the input

//in the example below, this fills the 'sample_normalInput' textbox with the string 'Foo Bar' //the onchange event is not executed genericForm.setValue({     'setting'   : 'sample_normalInput',     'value'     : 'Foo Bar',     'skipOnChange'  : true });

 

Return to Documentation Home I Return to Sangoma Support