xfgrAddOption
xfgrAddOption(
?optionName g_optionName
?optionLabel g_optionLabel
?optionType g_optionType
?optionWidgetType g_optionWidgetType
?optionDefaultValue g_optionDefaultValue
?supportedOptionValue g_supportedOptionValue
?groupName g_groupName
?deviceName g_deviceName
)
=> t / nil
Description
Adds a new field as specified in the option name to the Create Fluid Guard Ring form.
Arguments
|
?optionName g_optionName
|
|
|
The name of the option name to be added to the Create Fluid Guard Ring form.
|
|
?optionLabel g_optionLabel
|
|
|
The label of the option added to the Create Fluid Guard Ring form.
|
|
?optionType g_optionType
|
|
|
The type of option.
Valid values: boolean, string, integer, double.
|
|
?optionWidgetType g_optionWidgetType
|
|
|
The type of GUI widget for the specified option name.
Valid values: none, check box, line edit, combobox, spinbox, or radiobutton.
|
|
?optionDefaultValue g_optionDefaultValue
|
|
|
The default value for the option.
|
|
?supportedOptionValue g_supportedOptionValue
|
|
|
The values supported for the option. This is applicable for widget types combobox, spinbox, and radiobutton.
|
|
?groupName g_groupName
|
|
|
The location of the option on form.
Default value: CustomizedOptions
|
|
?deviceName g_deviceName
|
|
|
The device name for which this option is valid. By default, the option is applicable for all devices.
|
Value Returned
|
t
|
The option was added to the Create Fluid Guard Ring form.
|
|
nil
|
The option was not added to the Create Fluid Guard Ring form.
|
Example
Adds the new field, testOptionComboBox, to the Create Fluid Guard Ring form.
if(xfgrAddOption(?optionName "testOptionComboBox" ?optionLabel "ComboBox Label" ?optionType "string" ?optionWidgetType "combobox" ?groupName "CustomizedOptions" ?optionDefaultValue "option1" ?supportedOptionValue '("option1" "option2" "option3"))
info("Option added successfully")
else
info("Option not added")
Return to top
