ZOrder (Property)

Find out the z-order position of a control in a window or report. This z-order position is given in relation to the window or report. If the control is positioned on a tab, the z-order position is given in relation to the tab.
Modify the z-order position of a control (for example, define whether the control must be displayed in the foreground or in the background). The z-order of a control can be set in relation to the z-order position of another control in the window or report.

This property only applies to the controls found in a report.

This property can only be used to determine the z-order of a control.

Versions 16 and later

This property is now available for Windows Phone applications.

This property is now available for WINDEV applications in Linux.

New in version 16

This property is now available for Windows Phone applications.

This property is now available for WINDEV applications in Linux.

This property is now available for Windows Phone applications.

This property is now available for WINDEV applications in Linux.

Versions 17 and later

This property is now available for window controls in iPhone/iPad applications.

New in version 17

This property is now available for window controls in iPhone/iPad applications.

Versions 18 and later

This property is now available in Windows Store apps mode.

This property is now available for report controls in iPhone/iPad applications.

New in version 18

This property is now available in Windows Store apps mode.

This property is now available for report controls in iPhone/iPad applications.

This property is now available in Windows Store apps mode.

This property is now available for report controls in iPhone/iPad applications.

Versions 20 and later

This property is now available for Table controls in Android and iPhone/iPad applications.

New in version 20

This property is now available for Table controls in Android and iPhone/iPad applications.

Versions 21 and later

This property is now available in Universal Windows 10 App mode.

New in version 21

This property is now available in Universal Windows 10 App mode.

Example

See additional examples

// Depending on the value entered in the Radio Button control,
// one of the Image controls is displayed in the foreground
SWITCH RADIO_Image
CASE 1: IMG_Image_Car.ZOrder = 100
CASE 2: IMG_Image_Train.ZOrder = 100
CASE 3: IMG_Image_Plane.ZOrder = 100
END

Syntax

Finding out the z-order position of a control Hide the details

<Control Z-order> = <Control used>.ZOrder

<Control Z-order>: Integer

Z-order position included between 1 and the total number of controls found in the report block or in the window block.
The value 1 corresponds to the lowest z-order position (background).
The total number of controls corresponds to the highest z-order position (foreground).

<Control used>: Control name

Name of the control found in the window or in the report.

Modifying the z-order position of a control Hide the details

<Control used>.ZOrder = <New control Z-order>

<Control used>: Control name

Name of the control found in the window or in the report.

<New control Z-order>: Integer (greater than or equal to 1)

If the new z-order position is greater than the number of controls in the window or report, the control will be positioned in the foreground (on top of all the controls). Its actual z-order position will be equal to the number of controls found in the window or in the report.

Remarks

Single z-order position

Two controls belonging to the same group have a single z-order position.

Modifying the z-order position

When the z-order position of a control is modified, the z-order position of the other controls may also be modified (by 1).

If the z-order position of the control increases or decreases, only the controls whose z-order position is included between the former z-order position and the new z-order position are modified: the z-order position of these controls is automatically reduced by 1.
For example, if the z-order position of a control changes from 4 to 8, only the controls whose z-order position is included between 4 and 8 will be automatically modified: their z-order position will be reduced by 1 (the control whose previous z-order position was 5 will now have a z-order position of 4).

Limits

The ZOrder property only applies to controls in a window or report. This property cannot be used with the windows, menus, table columns, ...

The ZOrder property applies only to the following controls:

Button control.
Static control.
Edit control.
Image control.
Check Box control.
Radio Button control.
List Box control.
Combo Box control.
TreeView control.
Tab control.
Table control.
Supercontrol.

The ZOrder property has no effect on HTML controls.

Specific features with the Tab controls

If the window contains a Tab control:

A z-order position is assigned to the Tab control. This z-order position is given in relation to the window.
The z-order position of the controls found in the tab pane is given in relation to the Tab control. All the controls found in the tab pane have a different z-order position.