Methods of the LIST Object

Adds an image to the image list associated with the object.

Images have an implicit number corresponding to their position in the list, with the first image being number 1.

Note: To insert an image in the graphical list, you must specify the Image type for the column object's Adelia Type property and set the Value property to the number of the image that you want to display.

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

Adds an image to the end of the list of object images.

The images have an implicit number which corresponds to their position in the list. The first image has the number 1.

Note: To insert an image in the graphic list, the user must set the Image type for the Adelia Type property of the column object and assign the number of the image he/she wishes to display to the Value property.

Note: This method is not implemented by the Mobile generator.

Adds an image to the end of the list of object images.

The images have an implicit number which corresponds to their position in the list. The first image has the number 1.

Note: To insert an image in the graphic list, the user must set the Image type for the Adelia Type property of the column object and assign the number of the image he/she wishes to display to the Value property.

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

Indicates whether any data items in a specified format are available among the data concerned by the current drag and drop operation. The format can be either one predefined in Windows or one defined by the developer.

Notes:

This method is not implemented by the Java generator.

It is not available in Mobile generation.

Erases any data stored in the object that could have been used for a drag and drop operation.

This method concerns the data previously created by the DD_WRITE_DATA method.

Notes:

This method is not implemented by the Java generator.

It is not available in Mobile generation.

Initiates a drag and drop operation between a source object and a destination object using the data stored in the source object by the DD_WRITE_DATA method.

The relevant data can be either copied or moved to the destination object.

The set formed by this data is identified by a format name. The format can be either one predefined in Windows or one defined by the developer.

Note: Where a predefined format is used, only the first data item written by the DD_WRITE_DATA method is taken into consideration.

Notes:

This method is not implemented by the Java generator.

It is not available in Mobile generation.

Reads the data transferred as part of the current drag and drop operation. This data is in fact a copy of the data written in the source object by the DD_WRITE_DATA method.

This method must be used in a loop to run through all the data for a given Adelia type.

All the data for a given type is read when the number of data items read is less than the number of data items to be read.

Notes:

• • Calling this method with an Adelia array containing x elements has the same effect as calling the method x times with an Adelia variable.
  • If the DD_WRITE_DATA method has been used to write x records each containing two ALPHA variables, the DD_READ_DATA method must be run twice, with the indexes (2x - 1) and 2x, in order to retrieve the strings in the nth record, or once with the index (2x-1) and an array capable of receiving two data items.
  • No distinction is made between packed and extended numerical variables, however long they are and however many decimal places they have. The values of numerical and extended variables may be truncated when they are read. With strings, the read operation will fail if the Adelia variable is too small to contain the string being read.

Notes:

• • This method is not implemented by the Java generator.
  • It is not available in Mobile generation.

Adds data (i.e. the contents of the Adelia variables) to the data to be transferred by a drag and drop operation. This data is stored in the object until the end of the drag and drop operation, and is then deleted automatically.

Notes:

• • Calling this method with an array containing x elements has the same effect as calling the method x times with a variable containing the individual array elements.

  • No distinction is made between the extended and packed numerical data types.

Note: This method is not implemented by the Java generator. It is not available in Mobile generation.

Deletes an image in the object's image list.

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

Erases the sort indicators in the column headers in the list and sets to _COL_SORT_INDIC_ALLOWED the property SORT_INDICATOR in the columns that allow sort.

Note: This method is not implemented by the Java generator. It is not available in Mobile generation.

This method exports the contents of the graphical list to either a delimited ASCII file (text or ".csv" file) or a formatted Excel file. If an Excel file is used, many of the object's properties are included in the export.

Only the list's visible columns are exported.

Note:

In Windows client generation, if there is a Middleware configuration using the logical server *DOC_SERVER associated with a Middleware Java daemon the method behaves in the same was as for cloud generation, as shown below.

However, if the *DOC_SERVER configuration is not active, the data types are not preserved and the Excel cells all have text format.

Note for Windows Client generation with *DOC_SERVER or Cloud Client configuration:

Depending on the file extension (.xls or .xlsx) entered in the method, the product file will be in XLS or XLSX format.

The numeric data types and dates are preserved when exporting. This entails a number of limitations:

• • DATE and TIMESTAMP data prior to 1 January 1900 cannot be represented and appear as an error in Excel.
  • Excel is limited to 15 significant digits for numeric types. Numeric data with greater precision in Adelia (NUM_BIN_8, high accuracy NUM_E) may be rounded off.
  • It is not possible to hide the decimal point. This will be forced regardless of the edit code or edit word given. Edit code Z, in particular, will be displayed as edit code 4 in the Excel file, and display of edit code Y will be incorrect if the data type contains decimals.
  • The positions of the decimal and thousands separator characters ("." and ",") must be consistent in an edit word. If they are, the separators will be displayed correctly in the generated Excel format; if not, they will be treated as standard characters in the generated format. In all cases, for numeric characters with decimals, the decimal point will be displayed.
  • In an Adelia edit word, non-numeric characters to the left of the first figure displayed are not visible. In Excel format, they will be systematically.

Makes visible all the list's lines and executes the automatic filters defined on every column.

This method is useful for a list in which both manual and automatic filters have been defined. In that case, in the ACTION_FILTER event of columns defined with a manual filter, the user can execute all the automatic filters before executing his customized filter.

Important: Once the method is executed, the AfterAutoFilter event is triggered.

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

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

Retrieves the line and column numbers of the cell located in the specified position when the method is called. The position is represented by a pair of values (in pixels) relative to the top left corner of the list.

If the position matches a cell or a header, the CellFound Boolean variable is set to *TRUE.

If the position corresponds to a point located on the list's edge or background, the Boolean is set to *FALSE.

Collects the names of columns from the graphical list in an array.

The array is sorted according to the order of the columns in the graphical list.

Notes:
The length of the ColumnNameArray must be at least the specified size.

If there are more columns than the specified size, the return code will have the value -1 but the array will be filled.

Example of use: The names of retrieved objects may be used by the predefined &GET_OBJECT function to manipulate the object properties.

Note: This method is not used by the Java generator.

Returns the height of the line entered as a parameter.

Used to retrieve the keyboard keys which were defined when the previous GET_MOUSE_EVT_KEY method was called and which were in "pressed" state during the last 'MouseMove' event on the List object.

The length of the OtherKeysArray array must be at least the specified size.

The value of ShiftKeyState and CtrKeyState parameters is set to *True when the left or right Shift key and left or right Ctrl key respectively are in "pressed" state.

It is possible to differentiate between left and right keys using the values _LST_VIRTUAL_KEY_SHIFT_L and _LST_VIRTUAL_KEY_SHIFT_R for the Shift key and _LST_VIRTUAL_KEY_CTRL_L and _LST_VIRTUAL_KEY_CTRL_R for the Ctrl key in the OtherKeysTab parameter.

If the Alt Gr key is in "pressed" state, the value of AltKeyState and CtrlKeyState parameters is set to *True.

Notes:

This method is not implemented by the Java generator.

It is not available in Mobile generation.

Returns the object's current mode (selection or input) and status.

Sets the filter field to "*" and resets the INTERNAL_FILTER_VALUE property for all the columns in the list.

Authorizes the object to perform the necessary internal processes when updating a property or calling a LIST object or COLUMN object method.

The user can prevent the internal process from being run as many times as there are properties to update by placing the instructions between two calls to this method. The process will then only be run once.

The COLUMN object properties concerned are:

WIDTH

VISIBILITY

HEADER_FONT

FILTER

TEXT

ALIGNMENT

SORT_INDICATOR

The LIST object properties concerned are:

X_AXIS

Y_AXIS

WIDTH

HEADER_HEIGHT

ROLLUP_DYN_PAGIN et ROLLDOWN_DYN_PAGIN if at least one column has the property FILTER set to _COL_AUTOMATIC_FILTER_COMPLETE_LIST

The COLUMN object methods concerned are:

SET_COLUMN_NUMBER

INITIALIZE_FILTER_FIELD

Note: moving a column via the interface also updates the columns.

The LIST object method concerned is:

INITIALIZE_FILTER_FIELDS

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

Allows the object to be redrawn. The user can freeze the object display between two calls to this method.

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

Retrieves the properties for the COLUMN objects that make up the list, using the values of the properties of the line whose number is specified in LineNbr .

The following properties of the COLUMN object are updated: ALIGNMENT, BACKGROUND_COLOR, TEXT_COLOR, REVERSE_IMAGE, READ_ONLY, FONT, VALUE.

Retrieves the VALUE property for the COLUMN objects that make up the list, using the values of the line whose number is specified in LineNumber .

Retrieves the number of COLUMN objects that were frozen when calling the SET_FROZEN_COLUMNS method.

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

Sets the modifiable properties of the cells that make up the line whose number is specified in LineNbr .

The following properties are updated: ALIGNMENT, BACKGROUND_COLOR, TEXT_COLOR, REVERSE_IMAGE, READ_ONLY, FONT, VALUE.

Sets the values in the cells that make up the line which number is specified in LineNbr using the VALUE property of the COLUMN objects that make up the list. The line in the list will also be set to "Modified" status.

Places the focus on the object.

Freezes one or more COLUMN objects. A frozen column will not react to the actions made on the horizontal scroll bar. Columns are frozen consecutively from the left side of the object.

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

Used to define the keyboard keys for which it is desired to retrieve the state (pressed/released) at the time of the 'MouseMove' event on the list.

This method must be used before calling the GET_MOUSE_EVT_KEYS method of the same object.

The length of the OtherKeysArray array must be at least the specified size.

If the AlphaNumArray array is empty, the A->Z and 0->9 keys will not be tested the next time the GET_MOUSE_EVT_KEYS method is called.

Similarly, if the OtherKeysArraySize parameter is equal to 0 the "other" keys will not be tested the next time the GET_MOUSE_EVT_KEYS method is called.

Notes:

This method is not implemented by the Java generator.

It is not available in Mobile generation.

Used to toggle the object between selection mode (to select lines or cells) and input mode. You can lock the specified mode, meaning that the user is no longer able to switch between modes from the user interface.

• 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