Skip to main content
Version: Next

GET LIST ITEM PROPERTIES

GET LIST ITEM PROPERTIES ( {* ;} list ; itemRef | * ; enterable {; styles {; icon {; color}}} )

ParameterTypeDescription
*Operator→If specified, list is an object name (string) If omitted, list is a list reference number
listInteger, Text→List reference number (if * omitted), or Name of list type object (if * passed)
itemRef | *Operator, Longint→Item reference number, or 0 for last list item added, or * for the current list item
enterableBoolean←TRUE = Enterable, FALSE = Non-enterable
stylesInteger←Font style for the item
iconText, Integer←Picture name or number
colorInteger←RGB color value

This command is not thread-safe, it cannot be used in preemptive code.

Description​

The GET LIST ITEM PROPERTIES command returns the properties of the item designated by the itemRef parameterwithin the list whose list reference number or object name is passed in list.

If you pass the first optional * parameter, you indicate that the list parameter is an object name (string) corresponding to a representation of the list in the form. If you do not pass this parameter, you indicate that the list parameter is a hierarchical list reference (ListRef). If you only use a single representation of the list or work with structural items (the second * is omitted), you can use either syntax. Conversely, if you use several representations of the same list and work with the current item (the second * is passed), the syntax based on the object name is required since each representation can have its own current item.

Note: If you use the @ character in the object name of the list and the form contains several lists matching this name, the GET LIST ITEM PROPERTIES command will be applied to the first object whose name corresponds.

In itemRef, you can pass either a reference number, or the value 0 in order to designate the last item added to the list, or * in order to designate the current item of the list. If several items are selected, the current item is the last one selected.

If you pass * and no item is selected or if there is no item with the item reference number that is passed, the command leaves the parameters unchanged.

If you work with item reference numbers, build a list in which items have unique reference numbers, otherwise you will not be able to distinguish the items. For more information, refer to the description of the command APPEND TO LIST.

After the call:

  • enterable returns TRUE if the item is enterable.
  • styles returns the font style of the item.
  • icon returns the picture assigned to the item, if any.
    • If the icon has been specified using a picture file, the command returns in icon the pathname using the path: pattern.
    • If the icon has been specified using a library picture (binary databases only), the command returns either the number or the name of the picture, depending on the type of variable passed in this parameter. The following pattern is used for a name: pictlib:. If you do not attribute a specific type to the icon variable, by default, the name of the picture is returned (text). If no icon is associated with the item, the command returns a blank value.
    Note: You can retrieve, in a picture variable, the icon associated with an item using the GET LIST ITEM ICON command*.*
  • color returns the color of the text of the item specified.

For details about these properties, see the description of the command SET LIST ITEM PROPERTIES.

See also​

GET LIST ITEM
GET LIST ITEM ICON
SET LIST ITEM
SET LIST ITEM PROPERTIES