4D v16.3

LISTBOX Get locked columns

Home

 
4D v16.3
LISTBOX Get locked columns

LISTBOX Get locked columns 


 

LISTBOX Get locked columns ( {* ;} object ) -> Function result 
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)
Function result  Longint in Number of locked columns

The LISTBOX Get locked columns command returns the number of locked columns in the list box designated by the object and * parameters.

If you pass the optional * parameter, this indicates that the object parameter is an object name (a string). If you do not pass this parameter, this indicates that the object is a variable. In this case, you pass a variable reference instead of a string.

Columns can be locked through the Property List or using the LISTBOX SET LOCKED COLUMNS command. For more information,  refer to the Design Reference manual.

If a column is inserted or deleted by programming within the locked area, the number of columns returned by this command takes this change into account. For example, if you delete a locked column, the number of locked columns is decreased by 1. Similarly, if you insert a column by programming into a locked area, this column is locked automatically and the number of locked columns is increased by 1.

However, the command does not take into account the visible/invisible status of columns.



See also 

LISTBOX SET LOCKED COLUMNS

 
PROPERTIES 

Product: 4D
Theme: List Box
Number: 1152

 
HISTORY 

Created: 4D v13

 
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)