com.esri.arcgis.framework
Interface IDockableWindowManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

Application, Application, Application, Application, IDockableWindowManagerProxy

public interface IDockableWindowManager
extends Serializable

Provides access to a method that finds a dockable window in the application.

Description

A dockable window is a window that can exist in a floating state or be attached to the main application window. The Table of Contents in ArcMap and the Tree View in ArcCatalog are examples of dockable windows.

Remarks

The following code finds the ArcMap Table of Contents dockable window and, if it's currently visible, the TOC is docked on the right side of the application. You would get m_app from the hook in ICommand::OnCreate().

When To Use

The Application object implements the IDockableWindowManager interface that is used to get access to a particular dockable window. The GetDockableWindow method finds a dockable window using the UID of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Method Summary

IDockableWindow

getDockableWindow(IUID dockWnd) Finds a dockable window looking first in the collection and then in the category.

Method Detail

getDockableWindow

IDockableWindow getDockableWindow(IUID dockWnd)
                                  throws IOException,
                                         AutomationException

Finds a dockable window looking first in the collection and then in the category.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dockWnd - A reference to a com.esri.arcgis.system.IUID (in)

Returns:

A reference to a com.esri.arcgis.framework.IDockableWindow

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.