.
Eloquence JDLG contact contact


JDLG object and attribute reference:
ComboBox class

 
.
  Document revision: 2017-08-29
Refers to JDLG version: 1.7.6


Contents


The ComboBox class provides text entry and editing functionality, supported by an item list that may be used to select from a list of predefined content.

If the editable attribute is set to zero, a ComboBox object behaves similar to a PopText. However, a PopText provides more functionality.

Usually, a ComboBox object immediately follows an associated StaticText label in the same Dialog hierarchy level. The StaticText label usually defines an accelerator key to move the keyboard focus to the ComboBox object.

If editable, a ComboBox object provides the undo functionality through the Ctrl+Z or Meta+Z key combination and is subject to the configured insert and/or overwrite editing mode. If configured, the user may toggle between insert and overwrite mode using the INSERT key.

When an editable ComboBox receives the keyboard focus, the content is selected unless a mouse click moved the focus or the overwrite editing mode is active.

When the keyboard focus is moved away from a ComboBox, a nonzero rule value is returned to the program. Depending on the object which receives the keyboard focus, this may be subject to the RuleOverride functionality.

By default, editable ComboBox objects have a clipboard context menu assigned which is opened when the context menu mouse button is clicked. For details, please refer to the Context menus documentation.

add : string, set
Adds new items to the end of the item list.
Items are separated by LF (ASCII 10).
align : string, get/set
Specifies how the content and the items in the item list are horizontally aligned.

Possible values are:
 "left"
 "center"
 "right"

The default value is "left".

boxheight : integer, get/set
Specifies the height of the box displaying the item list, i.e., how many items are visible. If the item list contains more than the specified number of items, a vertical scroll bar is displayed.

The default value is 8.

class : string, get
Returns "ComboBox".
clear : integer or string, set
Deletes the content and the item list. The argument is ignored.
content : string, get/set
Used to get or set the content.
editable : integer, get/set
Nonzero (default): The ComboBox is editable.
Zero: The ComboBox is not editable.

Note: A ComboBox that is not editable behaves similar to a PopText. However, a PopText provides more functionality.

items : string, get/set
Used to get or set all items in the item list at once.
Items are separated by LF (ASCII 10).
line[] or line : string, get/set
Gets or sets the item in the item list with the specified index (starting with 1). If used without an index or with a zero index, the content is affected.

Note: On DLG SET, if used with an index, a new item is appended if the specified item does not exist. On DLG GET, if used with an index, ERROR 660 is issued if the specified item does not exist.

list : string, get/set
Alias for the items attribute (see above).
maxchars : integer, get/set
Limits the maximum number of characters.
rule : integer, get/set
If nonzero, the rule value is returned to the program, along with the path of the ComboBox object, when the keyboard focus is moved away from the ComboBox. Depending on the object which receives the keyboard focus, this may be subject to the RuleOverride functionality.

The default rule value is zero.

See also the documentation of the common rule attribute and the RuleOverride functionality.

Note: Unlike a PopText object, a ComboBox that is not editable does not submit the rule value when the selected line changes.


 
 
.
 
 
  Privacy | Webmaster | Terms of use | Impressum Revision:  2017-08-29  
  Copyright © 2002-2017 Marxmeier Software AG