guides:o4w:o4w_api:o4wtabox

O4WTABox routine

Creates a "type ahead list box."

O4WTABox(default, size, name, sourceType, Param1, Param2, Param3, Param4, param5, id, style)

The function has the following parameters:

ParameterDescription
defaultThe default value of the text in the list box.
sizeThe width of the list box.
nameThe name of the type ahead box.
sourceTypeThe source of the data to be placed into the list.

0 - The source of the data is explicit text.
1 - The source of the data is a code file.
2 - The source of the data is a code record.
3 - The source of the data is returned from a subroutine.
4 - The source of the data is a standard codes record.
param1Param1 should be valued based on sourceType.

0 - An @vm delimited list of display text.
1 - The name of the code file.
2 - The name of the code file.
3 - The name of the stored procedure to execute.
4 - The name of the standard code record to use.
param2Param2 should be valued based on sourceType.

0 - An @vm delimited list of codes.
1 - The field number in each record that contains the value to display.
2 - The name of the code record.
3 - <Null>
4 - <Null>
param3Param3 should be valued based on sourceType.

0 - <Null>
1 - Sort criteria. If not specified, will sort by @ID.
2 - The field number where the text to display is found.
3 - <Null>
4 - <Null>
param4Param4 should be valued based on sourceType.

0 - <Null>
1 - <Optional> Selection criteria. Explicit AND.
2 - The field number in the record containing the codes.
3 - <Null>
4 - <Null>
param5Param5 should be valued based on sourceType.

0, 3 - <Null>
1, 2, 4 - Contains the specification on how to match the input string.
Null - Use a case-insensitive match, returning any codes and text that contain the input string
1 - Use a case-insensitive match, returning any codes and text that begin with the input string
-1 - Use a case-sensitive match, returning any codes and text that begin with the input string.
idIf specified, the control can be addressed through style sheets individually.
styleIf specified, the style is applied to the text that is generated.

Note that <style> may be either the name of a style (as created by one of the O4W style functions, or as defined in an included style sheet), or it can be the returned value from one of the O4W style functions.
  • guides/o4w/o4w_api/o4wtabox.txt
  • Last modified: 2024/06/19 20:19
  • by 127.0.0.1