class_="checklist"

Using <widget class_="checklist"> creates a set of checkboxes with horizontal or vertical orientation.

Syntax

<dynamic var="">
    <widget class_="checklist" orientation_="[OPTION]" 
     label_="[LABEL_FOR_CHECKLIST]" value_="@var">
       [1010data_QUERY]
   </widget>
</dynamic>

The [1010data_QUERY] may be specified between the opening and closing tags of the <widget>. The results of the query provide data for the <widget> to display.

Attributes

The attributes in this list are specific to widgets with class_="checklist".

label_
Accepts text that is used as a label for the widget.
labelpos_
Accepts a string that specifies the position of the label for the widget.

Valid values are:

  • left
  • right
  • top
  • bottom

The default is left.

labelwidth_
Accepts an integer that specifies the width of the label for the widget.

If the length of the string specified by the label_ attribute is greater than the value specified for labelwidth_, the text will wrap over multiple lines.

If the labelwidth_ attribute is not specified, the default width is the length of the string specified by the label_ attribute.

orientation_
Specifies the orientation of the checklist.

Valid values are:

  • horizontal
  • vertical

The default is horizontal.

itemlabelpos_
Specifies where the list items should be positioned relative to the checkboxes in the widget. Accepts a string.

Valid values are:

  • right
  • left
  • top
  • bottom

The default is right.

itemspacing_
Controls the spacing between items. Accepts a non-negative number and a measurement unit (e.g., em, px).

The default value is 1em.

(Available as of version 12.00)

value_
The selected items are stored in the dynamic variable specified by this attribute as a comma-separated string in the order that they appear in the checklist (not the order in which they were selected).

The variable must be declared in the opening <dynamic> tag of the QuickApp (e.g., <dynamic var_name="">).

listvalue_
The selected items are stored in the dynamic variable specified by this attribute as a list-value consisting of the elements in the order that they appear in the checklist (not the order in which they were selected).

The variable must be declared as a list-value in the opening <dynamic> tag of the QuickApp (e.g., <dynamic var_name="{lst()}">).

textcolor_
Specifies the color of the list items. Accepts a string.

The color can be specified as any valid HTML color name, an RGB value, or a hex value.

textstyle_
Specifies the styling of the list items. Accepts a string.

Consists of a set of CSS key/value pairs (e.g., font-family:arial;font-weight:bold;font-size:14pt;).

textcolor_
Specifies the background color of the checklist widget. Accepts a string.

The color can be specified as any valid HTML color name, an RGB value, or a hex value.

maxrows_
Accepts an integer value that specifies the maximum number of rows in which the query associated with the widget can result.

If the query associated with the widget results in a number of rows that exceeds the value specified to maxrows_, then the widget produces an error.

The default value is 1000.

maxselected_
Accepts an integer value that specifies the maximum number of items that may be selected at one time in the widget.

Example for class_="checklist"

This example creates a simple checklist set up with 3 options. Results are shown below the code.

<dynamic storeselect="">
  <widget class_="checklist" base_="pub.demo.retail.item" 
   orientation_="vertical" value_="@storeselect">
    <sel value="g_first1(store;;)"/>
    <colord cols="store"/>
  </widget>
</dynamic>