Field-Map Scripting

4.1.1.2.7 InputOptionWithStartingValue

InputOptionWithStartingValue function


Prototype:

function InputOptionWithStartingValue (const caption, msg: string;

                                      labels: array of string;

                                      values: array of variant,

                                      StartingValue :variant,

                                      ShowCancelButton :boolean): variant;

Description:

The InputOption function displays a dialog allowing the user to choose from a number of options. It provides the choice of choosing starting entry. The dialog has a caption specified by the caption parameter, contains the text specified by the msg parameter, radio buttons with labels for every option and  "OK" and "Cancel" buttons.

Syntax:

variable := InputOptionWithStartingValue(Caption, Msg, [Label1..LabelN], [Value1..ValueN], StartingValue, ShowCancelButton);


Part

Description


variable

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 next to the radio buttons.


[Value1..ValueN]

An array of string values to be passed to memory if respective button is pressed by user.


StartingValue

Starting value of the list


ShowCancelButton

True if Cancel button will be part of the dialog, false if it won't.




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 := InputOptionWithStartingValue('Select species', 'List of species:', ['Norway sruce', 'European beech', 'European larch'], [0,1,2], 2, true);
End.



See also:

InputInteger; InputIntegerWithCounter; InputFloat; InputString; InputText; InputOption; InputOptionWithStartingValue; InputFromList;InputFromListWithStartingValue; InputFromCheckListTab; InputFromListTab