The Parameter element contains all information related to a single task parameter, including the following:
A name used to group two or more Parameter elements into a category.
When the value of the conditional expression in the Hide_if attribute is true, the parameter is hidden or made read-only. However, if the
Hide_if attribute is not specified, the parameter is always visible and read-write.
The following code hides or makes the parameter ArgName read-only when the value of
ArgName is
0 (false).
In the following sample code, the value of MyParameter will be hidden or made read-only when the value of
UpdateCategoryParam is not
SetIOManagerPointDigitalOutput. However,
UpdateCategoryParam is always visible and read-write because the
Hide_if attribute is not specified for this parameter.
→!= Const(\"SetIOManagerPointDigitalOutput\")";
|
The following sample code shows the value of the Hide_if attribute for
MyParameter. This expression hides or makes
MyParameter read-only when the value of
UpdateCategoryParam is not set to
SetIOManagerPointDigitalOutput.
The Script attribute contains the JavaScript script assigned to the task parameter. The JavaScript variable in the
Script attribute can be used to replace the value of the
Value attribute.
The Scriptable attribute indicates whether a Script Variable dialog box opens when the user selects the parameter in the Task Parameters area and then presses the
= (equals) key.
0 = The Script Variable dialog box does not open
1 = The Script Variable dialog box opens
The Scriptable attribute is only used for parameters where the value of the
Type attribute is
19 or
30.
The Style attribute represents how the parameter is rendered in the Task Parameters area.
0 = The parameter is always displayed in the Task Parameters area and is read-write
1 = The parameter is always displayed in the Task Parameters area and is read-only
2 = The parameter is hidden if the user selects the Hide disabled parameters check box in the Options dialog box; otherwise, the parameter is always displayed in the Task Parameters area and is read-only
The Type attribute represents the type of the field in the Task Parameters area.
0 = Provides a Boolean check box.
1 = Allows the user to specify a character string.
2 = Provides a drop-down list box.
3 = Provides a drop-down combo box.
4 = Allows the user to specify a device location.
5 = Allows the user to specify a labware or a fixed location. If the user specifies a labware,
VWorks software selects the location.
6 = Allows the user to specify both a location and the labware to use.
VWorks software then passes the location to the plugin.
7 = Opens the Well Selection dialog box.
8 = Allows the user to specify an integer.
9 = Allows the user to specify a file path.
10 = Provides a labware drop-down list box.
11 = Provides a liquid-class drop-down list box.
12 = Allows the user to specify a decimal fraction.
13 = Allows the user to specify a file path, where the value can be empty.
14 = Allows the user to enter a password and displays a series of asterisks to hide the password string.
15 = Allows the user to specify an IP address.
16 = Allows the user to select a directory.
17 = Allows the user to enter a time in the format
hh:mm:ss.
18 = Refers to an object in the JavaScript scripting context.
19 = Allows the user to enter a date. The format depends on the region and language settings.
20 = Allows the user to enter character strings that can wrap onto multiple lines.
21 = Opens the Pipette Technique Editor.
22 = Opens the Head Mode Selector dialog box.
23 = Describes the tip positions of a tip box.
24 = Opens the Field Composer dialog box.
25 = Displays the available hit pick format files. For example, when the user clicks the down arrow in the Format file field of the Hit pick replicate task, the list that is displayed is of this type.
26 =
Deprecated. Used to show the available analog input names in the device file where the plugin resides.
27 =
Deprecated. Used to show the available digital input names in the device file where the plugin resides.
28 =
Deprecated. Used to show the available digital output names in the device file where the plugin resides.
29 = Converts a parameter of this type to, and accesses it as, a JavaScript array object.
30 = Allows the user to specify a duration in the format
n Days hh:mm:ss.
31 = Displays a multi-line text box.
32 = Opens the color palette that enables the user to change the colors of various dialog box components.
The Units attribute specifies the appropriate unit of measure for the parameter.
The unit type is displayed next to the parameter name in the Task Parameters area. The following figure shows three unit types:
µL for microliters,
mm/µL for millimeters per microliter, and
mm for millimeters.
The Units attribute is specified for the following values of the
Type attribute:
|
•
|
When Type is 8 or 12, two Range child elements can contain integers that are used to specify a minimum value and a maximum value.
|
|
•
|
When Type is 3 or 12, each Range child element can contain an option in a drop-down menu.
|
In the previous figure, the upper and lower limits for the dynamic tip extension are 0 mm/µL and 20 mm/µL. The corresponding values of the related attributes are as follows:
This Value attribute is the default value of the
Type attribute. See
“Type attribute” .
For the following values of the Type attribute, the
Value attribute must contain an escaped XML block, as indicated in the following table:
The ValueToDisplay attribute specifies the value that is displayed in the Task Parameters area for a
Parameter element’s
Value attribute.
The values of ValueToDisplay and
Value are not always the same. For example, if
Value is JavaScript variable
"=variableA", then
ValueToDisplay should be the text string
"variableA".
The ValueToDisplay attribute, which is not set by the plugin developer, is seldom used. Therefore, the attribute is not shown in any of the sample code in this guide.
