InputFromListWithStartingValue function
Prototype: |
function InputFromListWithStartingValue (const caption, msg: string; labels: array of string; values: array of variant; const StartingValue :string; const ControlType :string) : variant; |
|
Description: |
The InputFromListWithStartingValue function displays a dialog allowing the user to choose from a number of listed options. It is extended version of InputFromList function which provides the choice of starting entry to input. The dialog has a caption specified by the caption parameter, contains the text specified by the msg parameter, list of options with labels for every option, "OK" and "Cancel" buttons and it enables to set up starting entry of the list. |
|
Syntax: |
variable := InputFromListWithStartingValue (Caption, Msg, [Label1..LabelN], [Value1..ValueN], 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. |
|
[Label1..LabelN] |
An array of string labels which will appear in the list of options. |
|
[Value1..ValueN] |
An array of string values to be passed to memory. |
|
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 |
|
Example:
Var choice : variant;
Begin
choice := InputFromListWithStartingValue('Select species', 'List of species:', ['Norway sruce', 'European beech', 'European larch'], [0,1,2], 1, 'LISTBOX');
End.
![]()
See also:
InputInteger; InputIntegerWithCounter; InputFloat; InputString; InputText; InputOption; InputOptionWithStartingValue; InputFromList;InputFromListWithStartingValue; InputFromCheckListTab; InputFromListTab
© 2024 IFER-Monitoring and Mapping Solutions