com.esri.arcgis.framework
Interface IDockableWindowDef

All Superinterfaces:
Serializable
All Known Implementing Classes:
ColorCorrectionDockWin, CreateFeatureDockWin, GxBrowserDockWindow, HistoryViewerWindow, IdentifyWindow, IDockableWindowDefProxy, InternalDockableWindow, MensurationDockWin, PixelInspectionDockWin, RasterToolsDockWin, TableDockWindow, TOCDockableWindow, UnplacedAnnotationWindow

public interface IDockableWindowDef
extends Serializable


Field Summary
static String IID
          Deprecated. Internal use only
static int IID3d1fa10a_f154_11d3_a67e_0008c7df97b9
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 String getCaption()
          The caption of the dockable window.
 int getChildHWND()
          The hWnd of the window to be embedded in a dockable window.
 String getName()
          The name of the dockable window.
 Object getUserData()
          User defined data.
 void onCreate(Object hook)
          Occurs when this dockable window is created and provides access to the application.
 void onDestroy()
          Occurs when the docking window is about to be destroyed.
 

Field Detail

IID3d1fa10a_f154_11d3_a67e_0008c7df97b9

static final int IID3d1fa10a_f154_11d3_a67e_0008c7df97b9
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

onCreate

void onCreate(Object hook)
              throws IOException,
                     AutomationException
Occurs when this dockable window is created and provides access to the application.

Parameters:
hook - A reference to another Automation Object (IDispatch) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildHWND

int getChildHWND()
                 throws IOException,
                        AutomationException
The hWnd of the window to be embedded in a dockable window.

Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
The name of the dockable window.

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.

Returns:
The caption
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onDestroy

void onDestroy()
               throws IOException,
                      AutomationException
Occurs when the docking window is about to be destroyed.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUserData

Object getUserData()
                   throws IOException,
                          AutomationException
User defined data.

Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.