Properties of the LIST Object

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the horizontal bar below the object, or when he/she resizes the window below and when the split bar expands (VERTICAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_HEIGHT) and if the object belongs to one of the bottommost views.

Note: This property is not implemented in Java and Mobile generation.

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the vertical bar to the left of the object, or when he/she resizes the window below and when the split bar expands (HORIZONTAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_WIDTH) and if the object belongs to one of the rightmost views.

Note: This property is not implemented in Java and Mobile generation.

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the vertical bar to the right of the object, or when he/she resizes the window below and when the split bar expands (HORIZONTAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_WIDTH) and if the object belongs to one of the rightmost views.

Note: This property is not implemented in Java and Mobile generation.

Defines the adjustment of an object placed in the view of a split bar object, when the user drags the horizontal bar above the object, or when he/she resizes the window above and when the split bar expands (VERTICAL_ADJUSTMENT property equal to _SPLT_ADJUST_EXPAND_HEIGHT) and if the object belongs to one of the bottommost views.

Note: This property is not implemented in Java and Mobile generation.

Allows the object to be placed in focus. Objects placed in focus are receptive to actions performed by the user using the keyboard and/or mouse.

Enables or disables the automatic rollup paging mode. If this property's value is *TRUE and the list's horizontal and vertical scroll bars are visible, a push button is displayed in the bottom right hand corner of the list object.

Three statuses (represented by 3 images) are available on this button:

• •   The list is completely loaded (the ROLLUP property equals *FALSE). A click on the button has no effect.
  •   The list is not completely loaded (the ROLLUP property equals *TRUE). A click on the button automatically triggers n executions of the Visual code associated with the Rollup event (the value n corresponding to the value of the NUMBER_AUTO_ROLLUP_DYN property). During this execution, the image on the button changes to . At the end of execution, if the list has been completely loaded the image changes to otherwise it changes back to .
  •   the list is loading. A click on the button stops loading. The button image changes back to .

Note:

Modification of the ROLLUP property by the program modifies the button's status and therefore its image. If the ROLLUP property equals true, the button image is , otherwise the image is .

A tooltip indicates the button's status. It is possible to change the text corresponding to each status by changing the name of the OBJECTSV.SAV file in the ADELIWS directory to OBJECTSV.INI, and by changing the value of the BTN_START_LOAD, BTN_ALL_LOADED and BTN_LOADING keys in the CONTAINR section.

Important: The key value must contain the "%d" string (which will receive the number of lines) and must not contain any additional "%" character.

Note: This property is not implemented by the Java generator or the Mobile generator.

Defines the object's background RGB color.

Draws a frame around the object.

Note: this property is only processed by Adelia Cloud.

Enables the width of column objects to be resized using the mouse.

Displays or hides a tooltip when the horizontal scroll bar's indicator moves. The tooltip text indicates the number of the first visible column in the list. By default the text is "column n".

It can be changed by changing the name of the OBJECTSV.SAV file in the ADELIWS directory to OBJECTSV.INI and by modifying the value of the TOOLTIP_SCROLLBAR_H key in the CONTAINR section.

Important: The key value must contain the "%d" string (which will receive the number of lines) and must not contain any additional 'r;%' character.

Note: This property is not implemented by the Java generator or the Mobile generator.

Number of the last active column (column associated with the element placed in focus).

Number of the last active line (line placed in focus).

Specifies whether an object can be the destination of drag and drop operations.

Note: This property is not implemented by the Java generator.

Lets you differentiate between odd and even ranked lines by using different text (ODD_LINE_TXT_COL and EVEN_LINE_TXT_COL properties) and background colors (ODD_LINE_BACK_COL and EVEN_LINE_BACK_COL properties).

Note: This property is not implemented by the Java generator.

Defines the background RGB color of elements making up the even lines in the list.

Note: This property is not implemented by the Java generator.

Defines the text RGB color of elements making up the even lines in the list.

Note: This property is not implemented by the Java generator.

Allows you to trigger the display of the filter definition box by clicking on the "Filter" field in the column header.

Number of the first visible column in the object. Column numbers begin with 1.

If you want to set as the first column visible a column with the VISIBILITY property equal to *FALSE, it is the first next column whose VISIBILITY property is *TRUE which will become the first column visible. If none of the next columns has the VISIBILITY property equal to *TRUE, no column will be shown in the list.

Note: This property is not implemented in Java generation.

Number of the first visible line in the object. Line numbers begin with 1.

Indicates the estimated number of lines visible in a graphical list. This value is estimated based on the height of the list and on the height of the line that will subsequently be added to the list. The line's height is calculated using the values of the columns' FONT properties.

Defines the RGB color of the lines that make up the grid.

Note: This property is not implemented in Mobile generation.

Defines the type of line used to display the grid lines.

Note: This property is not implemented in Mobile generation.

Defines how the lines that make up the grid will display.

Specifies the first object in a group of objects. A group of objects is defined by its first object and all the following objects (following the object sequence) until the first object in another group is reached. The user can use the arrow keys to change focus from one object to another within the same group.

Defines the RGB color of the object's header background.

Note: This property is not implemented by the Java generator.

Defines the RGB color of the object's header dark shadow (right and bottom edges of the header).

Note: This property is not implemented by the Java generator.

Height value of all the columns in the list.

Note: This property is not implemented in Mobile generation.

Defines the RGB color of the object's header light shadow (left and top edges of the header).

Note: This property is not implemented by the Java generator.

Defines the RGB color of the object's header text.

Note: This property is not implemented by the Java generator.

Height value of the object.

Used to manage how the horizontal and vertical scroll bars are displayed.

If the property is set to *FALSE, then the display of the scroll bars depends on the value of the PERMANENT_SCROLL_BARS property. Otherwise, they will always be hidden, even when the number of columns is higher than the column width or when the number of lines is higher than the column height.

Note: This property is not implemented by the Mobile and Java generators.

Defines how the graphical control is adjusted when the window is resized horizontally.

Height of the next line created or modified.

If this property is set to zero, the line height is adjusted to the font size defined for the columns.

Note: This property is not implemented by the Mobile and Java generators.

List of the elements in the object.

Used to permit only one element in the list to be selected.

Returns the number of the column on which the mouse cursor is positioned when the mouse event for the object LIST or COLUMN is triggered.

Returns the number of the line on which the mouse cursor is positioned when the mouse event for the object LIST or COLUMN is triggered.

This lets the user modify the sequence of the columns, by clicking on a column header and dragging it to the desired location.

Notes:

• • The fact that this property has the value *FALSE does not prevent you using the method SET_COLUMN_NUMBER for the COLUMN object.
  • It is possible to prevent movement of a given column to a given position whilst enabling movement of other columns.
  • The operating principle of column movement takes into account the existence of invisible columns. It is therefore possible to place a column in what appears to be its starting position when the column moved is adjacent to an invisible column.

Note: This property is not implemented by the Java generator.

Defines the way the user moves from the current line / column to the next line / column by the means of the keyboard keys or the mouse. This property is updated whenever the ChangeLineColumn event is triggered.

Number of the next active column (column associated with the element placed in focus). This property is updated whenever the ChangeLineColumn event is triggered.

Number of the next active line (line placed in focus). This property is updated whenever the ChangeLineColumn event is triggered.

Static name of the object.

Sets the number of times the code associated with the Rollup event is executed when the list is in automatic rollup paging mode (i.e. when the AUTO_ROLLUP_PAGIN_MODE property equals *TRUE).

Note: This property is not implemented by the Java generator or the Mobile generator.

Indicates the number of lines selected in the list.

Note: If the list is configured in cell selection mode, the value returned is 0.

Note: This property is not implemented by the Java generator.

Defines the background RGB color of elements making up the odd lines in the list.

Note: This property is not implemented by the Java generator.

Defines the text RGB color of elements making up the odd lines in the list.

Note: This property is not implemented by the Java generator.

Authorizes the object to draw itself over a control positioned in front of it in the window object order.

In the particular case where the window has a background image with transparent images placed in foreground, it is necessary to set the property to *TRUE if you wish to put the object after a "transparent" object in the tab order.

Reminder: an "overlapped" object must be placed after the background image, while a "non-overlapped" object must be placed before the background image.

For more information about managing overlapping of graphical objects, consult the working with object overlap section.

Note: This property is not implemented by the Java and Mobile generators.

Defines the character edit mode for the element in focus. If this property is set to "*TRUE", the caret mark will be visible in the element in focus; otherwise, the caret mark will be invisible, unless the user enters some text.

Used to manage how the horizontal and vertical scroll bars are displayed.

If the property is set to "*TRUE", scroll bars are always visible. Otherwise, they will only be displayed as and when necessary (i.e. when the number of columns is higher than the column width or when the number of lines is higher than the column height).

Note: This property is not implemented in Mobile generation.

Specifies whether or not the graphical list is refreshed after each operation affecting the list.
If REFRESH_STATUS is set to *TRUE, the list will be refreshed after every operation; otherwise, the list will not be refreshed.
The value of this property is modified using the REFRESH_LIST method.

Defines the character edit mode for the element in focus. If this property is set to "*TRUE", the input text replaces the existent text; otherwise the input text is concatenated on the right of the existent text.

Enables the Rolldown event to be triggered.

Enables the Rollup event to be triggered.

Defines the object's background RGB color of the selected line.

Note: This property is not implemented in Java generation or Mobile generation.

RGB color used to draw the text of the selected line.

Note: This property is not implemented in Java generation or Mobile generation.

Defines the type of selection used to select the cells that make up the object's lines.

This enables running of automatic sorting when the user clicks on a column header. The list is sorted in accordance with the column values, alternatively according to an ascending or descending order. A sorting indicator can be shown in the header to indicate the sorting sequence.

You can disable sorting for a given column (via the SORT_INDICATOR property of the COLUMN object). In this case, no sorting is carried out when you click on the header concerned.

Notes:

• • The SORT_ON_HEADER property allows you to perform sorting, but does not carry it out.
  • If the value is set to _LST_SORT_NONE, then sorting is disabled for all columns (the SORT_INDICATOR property for the columns is set to _COL_SORT_INDIC_DISABLED).

Note: This property is not implemented in Java generation or Mobile generation.

Allows the object to be placed in focus using the keyboard (TAB key or SHIFT+TAB).

Defines the background color of the tooltips associated with column headers, object elements and note indicators.

Note: This property is not implemented in Java and Mobile generation.

Authorizes the display of tooltips for column headers, object items and note indicators.

Note: This property is not implemented in Java and Mobile generation.

Defines the character font used to display the tooltips associated with column headers, object elements and note indicators.

The string format contains the name, size, style and script, in that order. A semi-colon must be inserted between each element.

If you set a property's value, you MUST specify the name and size.

Character font used to display the text in the object.

The string format contains the name, size, style and script, in that order. A semi-colon must be inserted between each element.

If you set a property's value, you MUST specify the name and size.

The different styles are specified using the following values:

• • 1: Normal (no special style)
  • 2: Strikethrough
  • 16: Italics
  • 256: Bold
  • 4096: Underlined

The style value to be specified in the string can either be one of the above values or else the sum of values other than 1.

The different script values are as follows:

Note:

The size, style and script must be compatible with the chosen font. The Windows system font selection dialog box, accessible via the graphical object's Properties pages, provides a guide for selecting coherent values.

The Font property is not available in Mobile generation or Java generation.

Displays or hides a tooltip when the vertical scroll bar's indicator moves. The tooltip text indicates the number of the first visible line in the list. By default the text is "line n".

It can be changed by changing the name of the OBJECTSV.SAV file in the ADELIWS directory to OBJECTSV.INI and by modifying the value of the TOOLTIP_SCROLLBAR_V key in the CONTAINR section.

Important: The key value must contain the "%d" string (which will receive the number of lines) and must not contain any additional "%" character.

Note: This property is not implemented by the Java, the Mobile and the Cloud generators.

Defines the text color of the tooltips associated with column headers, object elements and note indicators.

Note: This property is not implemented in Java and Mobile generation.

Time (in ms) between the moment when the mouse pointer stops over a column header or cell and the moment when the tooltip is displayed.

Note: This property is not implemented by the Java generator or the Mobile generator.

Defines the behavior of Ctrl+C (Copy) and Ctrl+X and Shift+Del (Cut) for the selected lines.

If the property's value is true, only the values of the visible columns are copied into the clipboard, otherwise all the columns are copied.

Note: This property is not implemented by the Java, the Mobile and the Cloud generators.

Used for making the background transparent in:

• • The list
  • The lines (unless odd and even lines colors are specified)
  • The cells (unless the column color is specified)

Note: this property is only processed by Adelia Cloud.

Defines how the graphical control is adjusted when the window is resized vertically.

Indicates whether the line is visible or not.

Visibility of the object.

Width value of the object.

Value of the object's X-axis, relative to the area covered by the window.

The reference point (origin) is the top left corner of the object.

Value of the object's Y-axis, relative to the area covered by the window.

The reference point (origin) is the top left corner of the object.

• Page:
  Events of the LIST Object
• Page:
  LIST (Visual Adelia Context)
• Page:
  Methods of the LIST Object
• Page:
  Properties of the LIST Object
• Page:
  Properties Relating to Events of the LIST Object