Get list item font
Get list item font ( {* ;} list ; itemRef | * ) : Text
| Parameter | Type | Description | |
|---|---|---|---|
| * | Operator | → | If specified, list is an object name (string) If omitted, list is a list reference number |
| list | Integer, Text | → | List reference number (if * omitted) or Name of list type object (if * passed) |
| itemRef | * | Longint, Operator | → | Item reference number or 0 for the last item added to the list or * for the current item of the list |
| Function result | Text | ← | Font name |
This command is not thread-safe, it cannot be used in preemptive code.
Description
The Get list item font command returns the current character font name of the item specified by the itemRef parameter of the list whose 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 that match this name, the Get list item font command will be applied to the first object whose name corresponds.
You can pass a reference number in itemRef. If this number does not correspond to any item of the list, the command does nothing. You can also pass 0 in itemRef in order to get the font of the last item added to the list (using APPEND TO LIST).
Lastly, you can pass * in itemRef: in this case, the command will get the font of the current item of the list. If several items are selected manually, the current item is the one that was selected last. If no item is selected, the command does nothing.