com.esri.arcgis.framework
Interface IDockableWindow

All Superinterfaces:

Serializable

All Known Implementing Classes:

DockableWindow, IDockableWindowProxy

public interface IDockableWindow
extends Serializable

Provides access to members that define and control a dockable window.

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 IDockableWindow interface is used to query the properties of a dockable window such as the Caption, Name, and ID. This interface also has methods to return whether the window is currently visible, to display the window, and to dock the window in a particular location on the application.

Use the IDockableWindowManager::GetDockableWindow method to get a reference to a particular dockable window.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	dock(int dockFlags) Docks or undocks this docking window.
String	getCaption() The caption of the dockable window.
IUID	getID() The unique id for this dockable window.
String	getName() The name of the dockable window.
Object	getUserData() User defined data.
boolean	isVisible() Indicates if this docking window is visible.
void	setCaption(String caption) The caption of the dockable window.
void	show(boolean show) Hides or shows the dockable window.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCaption

String getCaption()
                  throws IOException,
                         AutomationException

The caption of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The caption

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCaption

void setCaption(String caption)
                throws IOException,
                       AutomationException

The caption of the dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

caption - The caption (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getID

IUID getID()
           throws IOException,
                  AutomationException

The unique id for this dockable window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show(boolean show)
          throws IOException,
                 AutomationException

Hides or shows the dockable window.

Description

Show specifies whether the dockable window should be shown or hidden. Use True to show the window and False to hide the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if this docking window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The bVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dock

void dock(int dockFlags)
          throws IOException,
                 AutomationException

Docks or undocks this docking window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dockFlags - A com.esri.arcgis.framework.esriDockFlags constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

Object getUserData()
                   throws IOException,
                          AutomationException

User defined data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.