INSERT LISTBOX COLUMN

version 11 (Modified)

INSERT LISTBOX COLUMN ({*; }object; colPosition; colName; colVariable; headerName; headerVar)

The INSERT LISTBOX COLUMN command inserts a column in the list box set by the object and * parameters.

If you pass the optional * parameter, you indicate that the object parameter is an object name (string). If you do not pass this parameter, you indicate that the object parameter is a variable. In this case, you do not pass a string, but a variable reference. For more information about object names, refer to the Object Properties section.

The new column is inserted just in front of the column set using the colPosition parameter. If the colPosition parameter is greater than the total number of columns, the column is added after the last column.

Pass the name of the object and the variable of the inserted column in the colName and colVariable parameters.

• With an array type list box, the name of the variable must match the name of the array whose contents will be displayed in the column.

• With a selection type list box, you must pass a field or variable in the colVariable parameter. The contents of the column will thus be the value of the field or variable, evaluated for each record of the selection associated with the list box. This type of contents can only be used when the "Data Source" property of the list box is Current Selection or Named Selection (see the Management of List box objects section). You can use fields or variables of the string, number, Date, Time, Picture and Boolean types.

In the context of list boxes based on selections, INSERT LISTBOX COLUMN can be used to insert simple elements (fields or variables). If you want to handle more complex expressions (such as formulas or methods), you must use the INSERT LISTBOX COLUMN FORMULA command.

Note: It is not possible to combine columns of the array type (array data source) and those of the field or variable type (selection data source) in the same list box.

Pass the object name and the variable of the inserted column header in the headerName and headerVar parameters.

Note: Object names must be unique in a form. You must be sure that the names passed in the colName and headerName parameters are not already used. Otherwise, the column is not created and an error is generated.

1. We would like to add a column at the end of the list box:

   C_LONGINT(HeaderVarName;$Last;RecNum)
   ALL RECORDS([Table 1])
   $RecNum:=Records in table([Table 1])
   ARRAY PICTURE(Picture;$RecNum)

   $Last:=Get number of listbox columns(*;"ListBox1")+1
   INSERT LISTBOX COLUMN(*;"ListBox1";$Last;"ColumnPicture";Picture;"HeaderPicture";HeaderVarName)

2. We would like to add a column to the right of the list box and associate the values of the [Transport]Fees field with it:

   $last:=Get number of listbox columns(*;"ListBox1")+1
   INSERT LISTBOX COLUMN(*;"ListBox1";$last;"FieldCol";[Transport]Fees;"HeaderName";HeaderVar)

DELETE LISTBOX COLUMN, INSERT LISTBOX COLUMN FORMULA.