4D v16.3

LISTBOX SELECT BREAK

Home

 
4D v16.3
LISTBOX SELECT BREAK

LISTBOX SELECT BREAK 


 

LISTBOX SELECT BREAK ( {* ;} object ; row ; column {; action} ) 
Parameter Type   Description
Operator in If specified, object is an object name (string) If omitted, object is a variable
object  Form object in Object name (if * is specified) or Variable (if * is omitted)
row  Longint in Number of break row
column  Longint in Number of break column
action  Longint in Selection action

The LISTBOX SELECT BREAK command can be used to select break rows in the list box object designated by the object and * parameters. The list box must be displayed in hierarchical mode. 

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 pass a variable reference instead of a string.

Break rows are added to represent the hierarchy but they do not correspond to existing rows in the array. To designate a break row to be selected, in the row and column parameters, you must pass the row and column number corresponding to the first occurrence in the corresponding array. These values are returned by the LISTBOX GET CELL POSITION command when the user has selected a break row. This principle is described in the “Management of break rows” paragraph of the Managing Hierarchical List Boxes section.

The action parameter, if it is passed, can set the selection action to be carried out when a selection of break rows already exists in the list box. You can pass a value or one of the following constants, found in the "List Box" theme:

Constant Type Value Comment
lk add to selection Longint 1 The row selected is added to the existing selection. If the row specified already belongs to the existing selection, the command does nothing.
lk remove from selection Longint 2 The row selected is removed from the existing selection. If the row specified does not belong to the existing selection, the command does nothing.
lk replace selection Longint 0 The row selected becomes the new selection and replaces the existing selection. The command has the same effect as a user click on a row (however, the On Clicked event is not generated). This is the default action (if the action parameter is omitted).

Example  

Given the following arrays shown in a list box:

We want to select the "Normandy" break row:

 $row:=Find in array(T2;"Normandy")
 $column:=2
 LISTBOX COLLAPSE(*;"MyListbox") `collapsing of all levels
 LISTBOX SELECT BREAK(*;"MyListbox";$row;$column)

Here is the result:



See also 

LISTBOX GET CELL POSITION
LISTBOX SELECT ROW
Managing Hierarchical List Boxes

 
PROPERTIES 

Product: 4D
Theme: List Box
Number: 1117

 
HISTORY 

Created: 4D v12

 
ARTICLE USAGE

4D Language Reference ( 4D v16)
4D Language Reference ( 4D v16.1)
4D Language Reference ( 4D v16.2)
4D Language Reference ( 4D v16.3)