Simple class to define parameters to be included in the MacroParms class constructor or set afterward using an indexer. The changed property indicates if the user changed/entered a value.
Constructor
public MacroParm(string label, string name [, string text] [, string description]
[, FVInpEnum inputType], [, OrderdDictionary options])
Parameters
Parameter |
Type |
Description |
|---|---|---|
label |
Required String |
Label to display to the left of the input field |
name |
Required String |
Name of this parameter for accessing the text value |
text |
Optional String |
Starting text value of the parameter, default=null |
description |
Optional String |
Title to be associated with the HTML Input tag, default=null |
inputType |
Optional FVInpEnum |
Input type, default = FVInpEnum.text |
options |
Optional OrderedDictionary |
For RadioButtons type (and other complex options). The options OrderedDictionary should contain one code-text pair for each option. The key is the code to be passed and set as the value while the value is the text displayed to the user. Default=null |
Public Properties
Parameter |
Type |
Description |
|---|---|---|
changed |
boolean |
If the user changed/entered text this is true |
label |
String |
Label to display to the left of the input field |
name |
String |
Name of this parameter for accessing the text value |
text |
String |
text value of the parameter |
description |
String |
Title to be associated with the HTML Input tag |
inputType |
FVInpEnum |
Input type |
options |
OrderedDictionary |
Code-text pairs. |
Remarks
For the inputType FVInpEnum.radioButtons, the options need to be created in code prior to the call.
For the inputType FVInpEnum.checkbox, the description will be displayed to the right of the checkbox in the data entry area of the form. The text for "checked" is "true" and for not checked, "false".
Example
See example in the MacroParms class for defining in the constructor.
Alternatively, individual parameters can be defined individually, and will be displayed in the order they are set into a MacroParms object.
this.parms = new MacroParms("Logon Parameters", "Please Enter your UserID and Password");
this.parms["uid"]=new MacroParm("UserID","uid","Simmy","Enter the UserID");
this.parms["pw"]=new MacroParm("Password","pw",null,"Enter the Password-hint: host",FVInpEnum.password);
