SUI_AddFormField Table of Contents || Prev | Next || [?]
 
SUI_AddFormField (formType; fieldPtr; fieldLabel{; model{; formPage{; miscInfo{; labelObject}}}})
 
ParameterTypeDescription
formTypeInteger0 = output; 1 = input; 2 = dialog
fieldPtrPointerPointer to field object on form
fieldLabelStringField label
modelLongintlanguage model code
formPageIntegerForm page, if automatic goto page is desired
miscInfoStringMisc information (see description)
labelObjectStringObject name of field's label
 
Description

SUI_AddFormField allows you to voice-enable a field on an output, input or dialog form. When the label is spoken, the field will take focus, and the specified language model will be set. On output forms, this is used only for sorting and only the first three parameters are considered.

Example

On the input form for [Orders] you have a date field titled Order Date. To voice-enable this field, you call SUI_AddFormField in the input form method:

SUI_AddFormField (1;->[Orders]Order_Date;"Order Date";Date LM)

When "Order Date" is spoken, the following things will happen:

  • The Order_Date field will take focus
  • The Date language model will be enabled
  • If a date is spoken, SUI Pack will enter the date

To disable the voicing of a field 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 field 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.