Step 2 - Dock Manager

  • 3 minutes to read

In this step, you will learn how to use the Document Manager component along with the Dock Manager in a single application. The Dock Manager provides centralized control over the behavior and view settings of the dock panels it owns.

  1. Locate the DockManager component in the Visual Studio ToolBox and drop it onto the form.

    DockManager_Icon

    Alternatively, you can do it via the DocumentManager's smart tag, as illustrated in the figure below.

    Docking UI - Add DockManager

  2. Invoke the DockManager smart tag and add the required DockPanels via the corresponding links.

    DockingUI - Add Panels Smart Tag

    In Visual Studio, the Toolbox auto-hide panel is docked to the form's left edge, the Solution Explorer and Properties panels are docked to the right edge, and the Errors, Warnings and Messages panels are combined in a tabbed group at the bottom of the form. Emulate the layout illustrated below by adding six panels.

    DockingUI - Add DockPanels

    Notice that the Document Manager component is scaled automatically as new panels appear.

  3. Drag the panels to rearrange and dock them to specific places via docking hints.

    DockingUI - Re-arrange Panels

    After customizing the panels, you should have a UI similar to the one below.

    DockingUI - Customized Panels

  4. Now, when both DockManager and DocumentManager are used in a single form, you will gain several unique features from these controls. Their two main features are listed below.

    • End-users can press Ctrl+Tab or Ctrl+Shift+Tab to navigate via Documents and panels within the Document Selector. See the Document Selector topic for details.
    • DockPanels can be docked to DocumentManager as tabbed Documents. However, you cannot do the opposite - Documents cannot be docked to panels. This behavior is controlled by the DockManager.DockMode property, and emulates the behavior of Visual Studio.

    Refer to the Interaction with Dock Panels topic for more features.

  5. Dock panels display default buttons - Close, Auto-hide and Maximize. You can hide these buttons via the BaseDockOptions.ShowCloseButton, BaseDockOptions.ShowAutoHideButton and BaseDockOptions.ShowMaximizeButton properties and/or add your own Header Buttons. The figure below illustrates a custom 'Print' button added to the Errors panel.

DockingUI - CustomHeaderButton

As you can see, the custom Print button icon is painted in the skin color on hover. This feature is called Glyph Skinning, and allows you to paint your own custom buttons in the same pattern as default buttons. You can also use it to build monochrome UIs for your applications, where item captions and glyphs are painted in the same color. Many other controls besides DockManager support this feature. See the Glyph Skinning topic for a complete list.

All DevExpress controls and their elements use images and image settings from skins. To modify images of default DockPanel buttons (Close, Auto-Hide), run the WinForms Skin Editor and create a custom skin.

  • In Skin Editor, go to the "Bars" collection and expand the "Dock Panel Button Glyphs" item.
  • Select the required item state (for example, Normal) and load a new glyph. You can also colorize an existing image. To do this, double-click any glyph panel to open the Edit SVG Palette dialog, select the required glyph and set its new color.
  • Save your custom skin, export it as a .dll assembly, and add this library to your Visual Studio project. See this help topic for more information: Export and Apply Custom Skins.

Your Visual Studio-inspired application is almost complete. The final step is to add an application menu based on the Bar Manager component.

See Also