Skip to main content

TdxCustomDockControl.AllowDockClients Property

Specifies if and how other dock controls can be docked to it.

Declaration

property AllowDockClients: TdxDockingTypes read; write; default dxDockingDefaultDockingTypes;

Property Value

Type Default
TdxDockingTypes dxDockingDefaultDockingTypes

Remarks

Use the AllowDockClients property to specify whether dock controls are allowed to be docked to the left, top, right and bottom edges of the current control and whether they are allowed to fill the entire control’s area. For instance, if you want to prevent docking to the top edge of the control, set the AllowDockClients property to [dtClient, dtLeft, dtRight, dtBottom]. Note that the dtTop value is excluded from the set. (To perform the same at design-time, you need to set the dtTop flag of the AllowDockClients property to False. All other flags should be set to True.)

If an empty set is assigned to the AllowDockClients property, dock controls cannot be docked to the control. If any controls were already docked to it, they then float. Their AllowFloating properties are automatically set to True. (At design-time, you need to set all the flags of the AllowDockClients property to False to achieve such an effect.)

Note that you can also use the AllowDock property of the control being docked to specify the set of allowed operations. A docking operation succeeds only if both properties allow it.

Important

The AllowDock and AllowDockClients properties are taken into account only when performing the docking operation.

See Also