Skip to main content
Version: Next

LISTBOX Get footer calculation

LISTBOX Get footer calculation ( {* ;} object ) -> Function result

ParameterTypeDescription
*Operator🡒If specified, object is an object name (string)If omitted, object is a variable
objectForm object🡒Object Name (if * is specified) or Variable (if * is omitted)
Function resultLongint🡐Type of calculation

Description

The LISTBOX Get footer calculation command returns the type of calculation associated with the footer area of 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.

The object parameter can designate:

  • the variable or name of a footer area. In this case, the command returns the calculation associated with this area.
  • the variable or name of a list box column. In this case, the command returns the calculation associated with footer area of this column.

You can compare the value returned with the constants of the Listbox Footer Calculation theme (see the LISTBOX SET FOOTER CALCULATION command).

See also

LISTBOX SET FOOTER CALCULATION