OverlayWindow

• OverlayWindow (Class Definition) : System.Windows.Window, IOverlayWindow
• OverlayWindow (Visual Definition)
• OverlayWindow (Class Diagram)

The OverlayWindow class implements IOverlayWindow and is used to visualize floating docking buttons in AvalonDock.

The Screenshots on this page show the docking buttons in various scenarios in AvalonDock.

Visual Tree of OverlayWindow

• PART_DropTargetsContainer (Canvas)

  • PART_PreviewBox (Path)
  • PART_DockingManagerDropTargets (Grid)
  • PART_AnchorablePaneDropTargets (Grid)
  • PART_DocumentPaneDropTargets (Grid)
  • PART_DocumentPaneFullDropTargets (Grid)

• Invoke OverlayWindow.EnableDropTargets() to turn visibility of the OverlayWindow ON

• Invoke OverlayWindow.HideDropTargets() to turn visibility of the OverlayWindow OFF

• See IOverlayWindowHost implementation in

  • DockingManager
  • See LayoutAnchorableFloatingWindowControl

Source Images

The definition of the OverlayWindow control includes the bitmap images listed further below for the Generic theme.

Project Source folder: source/Components/AvalonDock/Themes/Generic/Images/

Floating Docking Button Name	Image
DockPane.PNG
DockPaneEmpty.png
DockBottom.PNG
DockLeft.PNG
DockRight.PNG
DockTop.PNG
InnerDockDocPaneBottom.png
InnerDockDocPaneLeft.png
InnerDockDocPaneRight.png
InnerDockDocPaneTop.png
InnerDockPaneBottom.png
InnerDockPaneInside.png
InnerDockPaneLeft.png
InnerDockPaneRight.png
InnerDockPaneTop.png

Visual Parts

PART_PreviewBox

Is the drop target rectangle that is displayed before a document or tool window is dropped into a drop target location.

PART_DockingManagerDropTargets

Outmost outter 4 overlay buttons that are displayed at border of MainWindow when user drags tool window over another tool window or document and the AvalonDock air space contains additional document(s) and tool windows (s). See also DockingManagerDropTarget control.

PART_AnchorablePaneDropTargets

Is displayed as center cross with a max of 5 buttons when a toolwindow is dragged over another tool window. See also AnchorablePaneDropTarget control.

PART_DocumentPaneDropTargets

Is displayed as center cross (see red buttons in screenshot) when documents are dragged over the document container. See also DocumentPaneDropTarget.

PART_DocumentPaneFullDropTargets

Is displayed as center cross (see red buttons in screenshot) when ToolWindows are dragged over the document container.

Methods

Public Methods

DragDrop

The DragDrop method is invoked by the DragService of a LayoutFloatingWindowControl, if a drag & drop operation is completed to display the LayoutFloatingWindowControl in a new docking position.

void IOverlayWindow.DragDrop( IDropTarget target )