Max
Max ( series {; attributePath} ) : any
| Parameter | Type | Description | |
|---|---|---|---|
| series | Field, Array | → | Data for which to return the maximum value |
| attributePath | Text | → | Path of attribute for which to return the maximum value |
| Function result | Date, Number | ← | Maximum value in series |
Description
Max returns the maximum value in series. If series is an indexed field, the index is used to find the maximum value.
You can pass an array (one or two dimensions) in series. In this case, the array must be of the Integer, Longint, Real, or Date type.
If the series selection is empty, Max returns 0.
This command accepts an optional attributePath parameter of the Text type, that you can use if series is an object field. It allows you to define the path of the attribute to compute. Use the standard dot notation to define paths to nested attributes, for example "company.address.number". Keep in mind that object attribute names are case-sensitive.
Only numeric attribute values are computed. If there are values in the attribute path which are not of a numeric type, they are ignored.
If the command is correctly executed, the OK system variable is set to 1. If it is interrupted (for example if the user clicks on the Stop button of the progress thermometer), the OK variable is set to 0.
Example 1
The following example is an object method for the variable vMax placed in the break 0 portion of the form. The variable is printed at the end of the report. The object method assigns the maximum value of the field to the variable, which is then printed in the last break of the report.
vMax:=Max([Employees] Salary)
Note: Make sure the "On printing break" form event is selected for the variable.
The following method is called to print the records in the selection and to activate break processing:
ALL RECORDS([Employees])
ORDER BY([Employees];[Employees]Company;>)
BREAK LEVEL(1)
ACCUMULATE([Employees]Salary)
FORM SET OUTPUT([Employees];"PrintForm")
PRINT SELECTION([Employees])
Note: The parameter to the BREAK LEVEL command should be equal to the number of breaks in your report. For more information about break processing, refer to the chapter Printing.
Example 2
This example gets the highest value in the array:
ARRAY REAL($ArrGrades;0)
QUERY([Exams];[Exams]Exam_Date=!01/07/11!)
SELECTION TO ARRAY([Exams]Exam_Grade;$ArrGrades)
vMax:=Max($ArrGrades)
Example 3
For an example of computing an object field attribute, please refer to the example 3 of the Average command description.
See also
Properties
| Command number | 3 |
| Thread safe | ✓ |
| Modifies variables | OK |