List Box Commands Summary

Home

4D v20.6

The following commands can be used with list boxes, or parts of list boxes such as headers, footers, rows, or columns.

List Box Commands

Command	List Box Type	Supported Parts
LISTBOX COLLAPSE	Hierarchical	List box, headers, footers, rows, columns
LISTBOX DELETE COLUMN	All	Columns
LISTBOX DELETE ROWS	Array	List box, headers, footers, rows, columns
LISTBOX DUPLICATE COLUMN	Array, Selection, Collection	Columns
LISTBOX EXPAND	Hierachial	List box, headers, footers, rows, columns
LISTBOX Get array	Array	List box, headers, footers, rows, columns
LISTBOX GET ARRAYS	All	List box, headers, footers, rows, columns
LISTBOX Get auto row height	Array	List box, headers, footers, rows, columns
LISTBOX GET CELL COORDINATES	All	List box, headers, footers, rows, columns
LISTBOX GET CELL POSITION	All	List box, headers, footers, rows, columns
LISTBOX Get column formula	Selection, Collection	Columns
LISTBOX Get column width	All	Columns
LISTBOX Get footer calculation	Array, Selection	Footers
LISTBOX Get footers height	All	Footers
LISTBOX GET GRID	All	List box, headers, footers, rows, columns
LISTBOX GET GRID COLORS	All	List box, headers, footers, rows, columns
LISTBOX Get headers height	All	Headers
LISTBOX GET HIERARCHY	Array	List box, headers, footers, rows, columns
LISTBOX Get locked columns	All	List box
LISTBOX Get number of columns	All	List box
LISTBOX GET OBJECTS	All	List box
LISTBOX GET PRINT INFORMATION	All	List box, headers, footers, rows, columns
LISTBOX Get property	All	List box, columns
LISTBOX Get row color as number	Array	Rows
LISTBOX Get row font style	Array	Rows
LISTBOX Get row height	Array	Rows
LISTBOX Get rows height	All	List box
LISTBOX Get static columns	All	List box
LISTBOX GET TABLE SOURCE	All	List box
LISTBOX INSERT COLUMN	All	List box
LISTBOX INSERT COLUMN FORMULA	All	List box
LISTBOX INSERT ROWS	Array	List box
LISTBOX MOVE COLUMN	All	Columns
LISTBOX MOVED COLUMN NUMBER	All	Columns
LISTBOX MOVED ROW NUMBER	Array	Rows
LISTBOX SELECT BREAK	Hierarchical	List box
LISTBOX SELECT ROW	All	Rows
LISTBOX SET ARRAY	Array	List box, columns
LISTBOX SET AUTO ROW HEIGHT	Array	Rows
LISTBOX SET COLUMN FORMULA	Selection, Collection	Columns
LISTBOX SET COLUMN WIDTH	All	Columns
LISTBOX SET FOOTER CALCULATION	Array, Selection	Footers
LISTBOX SET FOOTERS HEIGHT	All	Footers
LISTBOX SET GRID	All	List box
LISTBOX SET GRID COLOR	All	List box
LISTBOX SET HEADERS HEIGHT	All	Headers
LISTBOX SET HIERARCHY	Array	List box
LISTBOX SET LOCKED COLUMNS	All	List box
LISTBOX SET PROPERTY	All	List box, columns
LISTBOX SET ROW COLOR	Array	Rows
LISTBOX SET ROW FONT STYLE	Array	Rows
LISTBOX SET ROW HEIGHT	Array	Rows
LISTBOX SET ROWS HEIGHT	All	List box
LISTBOX SET STATIC COLUMNS	All	List box
LISTBOX SET TABLE SOURCE	Selection	List box
LISTBOX SORT COLUMNS	All	Columns

Miscellaneous Commands

Command	List Box Type	Supported Parts	Comments
EDIT ITEM	All	columns	allows you to pass a cell of a list box object into edit mode
Get edited text	All	List box, headers, footers, rows, columns
REDRAW	Array, Selection	List box	when applied to a selection list box, triggers an update of the data displayed in the list box. Not supported with list box of the entity selection type.
Displayed line number	All	List box, headers, footers, rows, columns	functions in the context of the On Display Detail form event for a list box object
Drop position	All	List box, headers, footers, rows, columns
Count in array	All	List box, headers, footers, rows, columns
Print object	All	List box, headers, footers, rows, columns

Object commands

Command	List Box Type	Supported Parts
OBJECT DUPLICATE	All	List box, headers, footers, rows, columns
OBJECT GET BEST SIZE	All	Columns
OBJECT Get border style	All	List box, headers, footers, rows, columns
OBJECT GET COORDINATES	All	List box, headers, footers, rows, columns
OBJECT Get data source	Array	List box
OBJECT GET DRAG AND DROP OPTIONS	All	List box, headers, footers, rows, columns
OBJECT Get enterable	All	Columns
OBJECT Get filter	All	Columns
OBJECT Get focus rectangle invisible	All	List box, headers, footers, rows, columns
OBJECT Get font	All	List box, headers, footers, rows, columns
OBJECT Get font size	All	List box, headers, footers, rows, columns
OBJECT Get font style	All	List box, headers, footers, rows, columns
OBJECT Get format	All	Headers
OBJECT Get help tip	All	Headers, footers
OBJECT Get horizontal alignment	All	List box, headers, footers, columns
OBJECT Get list reference	All	Columns
OBJECT Get name	All	List box, headers, footers, rows, columns
OBJECT Get pointer(1)	All	List box, headers, footers, rows, columns
OBJECT GET RESIZING OPTIONS	All	List box, headers, footers, rows, columns
OBJECT GET RGB COLORS	All	List box, headers, footers, rows, columns
OBJECT GET SCROLL POSITION	All	List box
OBJECT GET SCROLLBAR	All	List box
OBJECT Get type	All	List box, headers, footers, columns
OBJECT Get vertical alignment	All	List box, headers, footers, columns
OBJECT MOVE	All	List box, headers, footers, rows, columns
_o_OBJECT SET COLOR	All	List box, headers, footers, rows, columns
OBJECT SET COORDINATES	All	List box
OBJECT SET DATA SOURCE	All	List box
OBJECT SET ENTERABLE	All	Columns
OBJECT SET EVENTS	All	List box
OBJECT SET FOCUS RECTANGLE INVISIBLE	All	List box, headers, footers, rows, columns
OBJECT SET FONT	All	List box, headers, footers, rows, columns
OBJECT SET FONT SIZE	All	List box, headers, footers, rows, columns
OBJECT SET FONT STYLE	All	List box, headers, footers, rows, columns
OBJECT SET FORMAT	All	List box, headers, footers, rows, columns
OBJECT SET HELP TIP	All	Headers, footers
OBJECT SET HORIZONTAL ALIGNMENT	All	List box, headers, footers, columns
OBJECT SET RESIZING OPTIONS	All	List box, headers, footers, rows, columns
OBJECT SET RGB COLORS	All	List box, headers, footers, rows, columns
OBJECT SET SCROLL POSITION	All	List box
OBJECT SET SCROLLBAR(2)	All	List box
OBJECT SET TITLE	All	Headers
OBJECT SET VERTICAL ALIGNMENT	All	List box, headers, footers, columns
OBJECT SET VISIBLE(3)	All	List box, headers, footers

(1) See paragraph below.
(2) Scrolls the list box rows so that the first selected row or a specified row is displayed
(3) When OBJECT SET VISIBLE is used with a header or footer, it is applied on all List box object headers or footers, regardless of the individual element set by the command. For example, the OBJECT SET VISIBLE(*;"header3";False) instruction will hide all headers in the List box object to which header3 belongs and not simply this header. Note that in order for you to be able to manage the visibility of these objects using the OBJECT SET VISIBLE command, they must have been displayed in the list box properties

OBJECT Get pointer

The OBJECT Get pointer function used with the Object with focus or Object current constant (formerly the Focus object and Self functions) can be used in the object method of a list box or a list box column. They return a pointer to the list box, the list box column(1) or the header variable depending on the type of form event. The following table details this functioning:

Event	Object with focus	Object current
On Clicked	list box	column
On Double Clicked	list box	column
On Before Keystroke	column	column
On After Keystroke	column	column
On After Edit	column	column
On Getting Focus	column or list box (*)	column or list box (*)
On Losing Focus	column or list box (*)	column or list box (*)
On Drop	list box source	list box (*)
On Drag Over	list box source	list box (*)
On Begin Drag Over	list box	list box (*)
On Mouse Enter	list box (**)	list box (**)
On Mouse Move	list box (**)	list box (**)
On Mouse Leave	list box (**)	list box (**)
On Data Change	column	column
On Selection Change	list box (**)	list box (**)
On Before Data Entry	column	column
On Column Moved	list box	column
On Row Moved	list box	list box
On Column Resize	list box	column
On Open Detail	Nil	list box (**)
On Close Detail	Nil	list box (**)
On Header Click	list box	header
On Footer Click	list box	footer
On After Sort	list box	header

(*) When the focus is modified within a list box, a pointer to the column is returned. When the focus is modified at the overall form level, a pointer to the list box is returned. In the context of a column object method, a pointer to the column is returned.
(**) Not executed in the context of a column object method.

(1) When a pointer to a column is returned, the object pointed to depends on the type of list box. With an array type list box, the OBJECT Get pointer function (“User Interface” theme) returns a pointer to the column of the list box with the focus (i.e. to an array). The 4D pointer mechanism allows you to see the item number of the modified array. For example, supposing a user modified the 5th line of the column col2:

 $Column:=OBJECT Get pointer(Object with focus)

  ` $Column contains a pointer to col2

 $Row:=$Column-> `$Row equals 5

For a selection type list box, the OBJECT Get pointer function returns:

For a column associated with a field, a pointer to the associated field,
For a column associated with a variable, a pointer to the variable,
For a column associated with an expression, the Is nil pointer pointer.