Skip to main content
Version: Next

LISTBOX Get static columns

LISTBOX Get static columns ( {* ;} object ) : Integer

ParameterTypeDescription
*OperatorIf specified, object is an object name (string)If omitted, object is a variable
objectanyObject Name (if * is specified) or Variable (if * is omitted)
Function resultIntegerNumber of static columns

This command is not thread-safe, it cannot be used in preemptive code.

Description

The LISTBOX Get static columns command returns the number of static 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.

Static columns can be set through the Property List or using the LISTBOX SET STATIC COLUMNS command.

If a column is inserted or deleted by programming within a set of static columns, the number of columns returned by this command takes this change into account.
However, the command does not take into account the visible/invisible status of columns.

Note: Static columns and locked columns are two independent functions. For more information, refer to the Design Reference manual.

See also

LISTBOX SET STATIC COLUMNS