4.1.1.2.11 InputFromListTab

Prototype:

function InputFromListTab (const caption, msg: string;

                           tab :TTableWrapper;

                           const ValueAttribute :string;

                           const LabelAttributes :array of string;

                           const LabelFormatString :string;

                           const StartingValue :variant;

                           const ControlType :string) :variant

Description:

The InputFromListTab function displays a dialog allowing the user to choose from a number of listed options. The listed options come from a table. The dialog has a caption specified by the caption parameter, contains the text specified by the msg parameter, check boxes with labels for every option, "OK" and "Cancel" buttons.

Syntax:

variable := InputFromListTab (Caption, Msg, Tab, ValueAttribute, [Label1..LabelN], LabelFormatString, StartingValue, ControlType);

Part

Description

variable

A variable declared as variant

Caption

A string parameter which specifies the caption of the dialog box.

Msg

A string parameter which specifies the message displayed in the dialog box.

Tab

A table of TTableWrapper type

ValueAttribute

A column from the tab that defines the values for the options

[Label1..LabelN]

A column from the tab that defines labels for the options

LabelFormatString

A variable declared as string; a format string for the formatted attributes

StartingValue

Starting value of the list

ControlType

A string parameter which specifies selection view. For example 'GRID', 'LISTBOX'.

Return value:

The value of the selected option as a variant or "-1" if the user has pressed the “Cancel” button