Provides access to members that define a dockable window.
Product Availability
Description
A dockable window definition is used by the application to create a dockable window. A dockable window is an auxilary window that can be used to display data. This window can exist in a modeless floating state or be attached to the main application window.
When To Use
To create your own dockable window, you would implement the IDockableWindowDef interface.
Members
| Description | ||
|---|---|---|
 |
Caption | The caption of the dockable window. |
|
ChildHWND | The hWnd of the window to be embedded in a dockable window. |
|
Name | The name of the dockable window. |
 |
OnCreate | Occurs when this dockable window is created and provides access to the application. |
|
OnDestroy | Occurs when the docking window is about to be destroyed. |
|
UserData | User defined data. |
CoClasses that implement IDockableWindowDef
| CoClasses and Classes | Description |
|---|---|
| ArcToolboxDockWnd (esriGeoprocessingUI) | |
| CreateFeatureDockWin (esriEditor) | Esri create features window. |
| ErrorWindow (esriEditorExt) | Esri topology error inspector. |
| GPCommandWindow (esriGeoprocessingUI) | |
| GxBrowserDockWindow (esriCatalogUI) | The Catalog window dockable window. |
| HistoryViewerWindow (esriArcMapUI) | History Viewer Window |
| IdentifyWindow (esriArcMapUI) | Esri map identify window. |
| SharedFeaturesDockWindow (esriEditorExt) | |
| TableDockWindow (esriArcMapUI) | Table dock window |
| TOCDockableWindow (esriArcMapUI) | Esri TOC Dockable Window. |
| UnplacedAnnotationWindow (esriEditor) | Esri unplaced anno window. |
Remarks
This interface allows you to set properties such as caption and name. You use the ChildHWND property to define what the window will consist of by passing in an hWnd of a control such as a form, listbox, etc. The OnCreate method provides a hook to the application and allows you to perform any necessary initialization of the window. The OnDestroy method is called when the window is about to be destroyed.
The class you create is a definition for a dockable window; it is not actually a dockable window object. Once your class is registered in one of the dockable window component categories, the application uses the definition of the dockable window in your class to create the actual dockable window.