SUI_AddFormArray Table of Contents || Prev | Next || [?]
 
SUI_AddFormArray (formType; arrayName; arrayLabel{; gotoPage{; labelObject}})
 
ParameterTypeDescription
formTypeInteger1 = input; 2 = dialog
arrayNameStringName of the process array
arrayLabelStringThe label of the object using the array
gotoPageIntegerForm page number
labelObjectStringObject name of label
 
Description

SUI_AddFormArray allows you to prepare a form object using an array, such as a pull-down menu. When the label is spoken, the object will take focus, and the array will be used to create a new active language model.

Example

On the input form for [Employees] you have a pull-down menu using the array aEmpStatus. To voice-enable this menu, you call SUI_AddFormArray in the input form method:

SUI_AddFormArray (1;"aEmpStatus";"Employee Status")

When "Employee Status" is spoken, the following things will happen:

  • The pull-down menu will take focus
  • An active language model will be created using the contents of aEmpStatus
  • If an array element is spoken, SUI Pack will set the array to that element

To disable the voicing of an array object, use SUI_RemFormObject.

New in v3.0.0
You can now pass the object name of the area's label, or of a colored rectangle used to highlight the area. When the interface object using the array takes focus, you can use this new feature to alter the label (such as underline it), or make a colored box appear behind the object. See SUI_SetMiscParm (parms 1 and 2) for settings.