TdxZone.DockIndex Property

Returns the dock index that controls will have when docked to this zone.

Declaration

property DockIndex: Integer read;

Property Value

Type
Integer

Remarks

The DockIndex property is useful for dock zones only. It indicates the value of the DockIndex property that controls docked to this zone will have. Note however, that the DockIndex property returns -1 for most zones. This is because most dock controls are docked to controls that are not containers. For instance, if docking a control to a side container, it is actually docked to one of the controls residing in it and the side container becomes the control’s parent. In this case, the DockIndex property of the control will differ from the DockIndex property of the zone where it has been docked.

The DockIndex property returns a value that matches the DockIndex property of controls only in zones residing in tabs of a tab container. In this case, controls are docked directly to the tab container, not one of its child controls. Thus, the dock index of the docked control can be determined. It is equal to the dock index of the control corresponding to the tab where the dock zone resides.