Dockable windows are configurable windows inside the application that present additional data typically related to the active view. For example, in ArcMap, the table of contents and the Catalog window are dockable windows. Dockable windows can be moved and docked inside the application or they can float. When docked, dockable windows can be marked as unpinned to maximize application real estate. Inherit this abstract class to create a dockable window.

Namespace:  ESRI.ArcGIS.Desktop.AddIns

Assembly:  ESRI.ArcGIS.Desktop.Addins (in ESRI.ArcGIS.Desktop.Addins.dll) Version: 10.0.0.0 (10.0.0.0)

Syntax

C#
public abstract class DockableWindow : IDisposable
Visual Basic (Declaration)
Public MustInherit Class DockableWindow _
	Implements IDisposable
Visual C++
public ref class DockableWindow abstract : IDisposable

Remarks

Use the add-in xml file (Config.esriaddinx) to set the dockable window's caption, image, and initial representation settings such as height, width, state, position and neighbor.

Examples

The code below shows an implementation of a dockable window.
CopyC#
public class DockWin : ESRI.ArcGIS.Desktop.AddIns.DockableWindow
{
  private DockableWindow1 m_windowUI;

  public DockWin()
  {
  }

  protected override IntPtr OnCreateChild()
  {
    m_windowUI = new DockableWindow1();
    return m_windowUI.Handle;
  }
}
public partial class DockableWindow1 : UserControl
{
  public DockableWindow1()
  {
    InitializeComponent();
  }
}
CopyVB.NET
Public Class DockWin
  Inherits ESRI.ArcGIS.Desktop.AddIns.DockableWindow
  Private m_windowUI As DockableWindow1

  Public Sub New()
  End Sub

  Protected Overloads Overrides Function OnCreateChild() As IntPtr
    m_windowUI = New DockableWindow1()
    Return m_windowUI.Handle
  End Function
End Class
Partial Public Class DockableWindow1
  Inherits UserControl
  Public Sub New()
    InitializeComponent()
  End Sub
End Class

Inheritance Hierarchy

System..::.Object

  ESRI.ArcGIS.Desktop.AddIns..::.DockableWindow

See Also