Docking Operations
- 3 minutes to read
This topic describes how end-users can perform docking operations. Also, it provides information on the properties and options that affect the availability of such operations and the result of performing them.
Basically, docking operations use drag and drop. Dragging can be initiated in the caption area of a dock control or in its corresponding tab (when a control is a child of a tab container). After dragging has been started, the control remains at the same position. Its potential target position and size are displayed by a docking frame as shown in the image below.
Note
the frame shown in the image above can be painted in a custom manner. Please refer to the Docking Frame and Resizing Bar Custom Painting topic for more information regarding this.
Anytime during the docking operation, end-users can press the ESC key to cancel the current operation. The dock control remains at the same position and the docking frame. Also, they can use the CTRL key when performing docking operations. When this key is pressed, the dock control cannot be docked to a dock site or another control if dropped. This is useful, for instance, if you want the control to float over a dock site. If dropped when not using the CTRL key, the control will be docked to the site or the control residing under the mouse pointer.
Note that there are four properties that affect the individual behavior of dock controls:
| Property | Description |
|---|---|
| AllowDock | Specifies how the dock control can be docked to other dock controls. |
| AllowDockClients | Specifies how other dock controls can be docked to the dock control. |
| AllowFloating | Specifies whether the dock control can be made to float. |
| Dockable | Specifies whether docking operations can be performed on the dock control. |
Another way of performing docking operations is to double-click the caption of a dock control. If the control is currently docked to a dock site, tab container or side container, it then floats. If the caption is double-clicked once again, the dock control is restored to its previous position.
Note
This functionality can be disabled by deactivating the docking manager’s doDblClickDocking option. Please refer to the docking manager’s Options property description for details.
Docking functionality can also be controlled by handling events. Please refer to the Controlling Docking Operations topic for details. The Performing Docking Operations via Code topic, in turn, shows how to perform docking operations using code.
Note that tab containers and side containers have particular facilities related to docking operations. Please refer to their descriptions for details.