4D v13.4
LISTBOX SELECT BREAK
- 4D Language Reference
-
- List Box
-
- Managing List Box Objects
- Managing Hierarchical List Boxes
- LISTBOX COLLAPSE
- LISTBOX DELETE COLUMN
- LISTBOX DELETE ROWSUpd
- LISTBOX EXPAND
- LISTBOX GET ARRAYSUpd
- LISTBOX GET CELL POSITION
- LISTBOX Get column formulaNew
- LISTBOX Get column width
- LISTBOX Get footer calculationNew
- LISTBOX Get footers heightNew
- LISTBOX GET GRID COLORSNew
- LISTBOX GET GRIDNew
- LISTBOX Get headers heightNew
- LISTBOX GET HIERARCHY
- LISTBOX Get informationUpd
- LISTBOX Get locked columnsNew
- LISTBOX Get number of columns
- LISTBOX Get number of rows
- LISTBOX GET PRINT INFORMATION
- LISTBOX Get rows heightUpd
- LISTBOX Get static columnsNew
- LISTBOX GET TABLE SOURCEUpd
- LISTBOX INSERT COLUMN FORMULAUpd
- LISTBOX INSERT COLUMNUpd
- LISTBOX INSERT ROWSUpd
- LISTBOX MOVED COLUMN NUMBER
- LISTBOX MOVED ROW NUMBER
- LISTBOX SELECT BREAK
- LISTBOX SELECT ROW
- LISTBOX SET COLUMN FORMULANew
- LISTBOX SET COLUMN WIDTH
- LISTBOX SET FOOTER CALCULATIONNew
- LISTBOX SET FOOTERS HEIGHTNew
- LISTBOX SET GRID
- LISTBOX SET GRID COLOR
- LISTBOX SET HEADERS HEIGHTNew
- LISTBOX SET HIERARCHY
- LISTBOX SET LOCKED COLUMNSNew
- LISTBOX SET ROWS HEIGHTUpd
- LISTBOX SET STATIC COLUMNSNew
- LISTBOX SET TABLE SOURCEUpd
- LISTBOX SORT COLUMNS
LISTBOX SELECT BREAK
| LISTBOX SELECT BREAK ( {* ;} object ; row ; column {; action} ) | ||||||||
| Parameter | Type | Description | ||||||
| * | Operator |
|
If specified, object is an object name (string) If omitted, object is a variable | |||||
| object | Form object |
|
Object name (if * is specified) or Variable (if * is omitted) | |||||
| row | Longint |
|
Number of break row | |||||
| column | Longint |
|
Number of break column | |||||
| action | Longint |
|
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 |
| Add to listbox 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. |
| Remove from listbox 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. |
| Replace listbox 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). |
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:
Product: 4D
Theme: List Box
Number:
1117
Created: 4D v12
LISTBOX GET CELL POSITION
LISTBOX SELECT ROW
Managing Hierarchical List Boxes
