com.esri.arcgis.arcmapui
Interface IDataWindow

All Superinterfaces:

Serializable

All Known Subinterfaces:

IDataGraphWindow2, IGenericWindow, ILensWindow, IMapInsetWindow, IOverviewWindow, ITableWindow, ITableWindow2, ITableWindow3

All Known Implementing Classes:

DataGraphWindow, GenericWindow, IDataWindowProxy, IGenericWindowProxy, ILensWindowProxy, IMapInsetWindowProxy, IOverviewWindowProxy, MapInsetWindow, OverviewWindow, TableWindow

public interface IDataWindow
extends Serializable

Provides access to members that control popup windows that show map data.

Superseded By

IDataWindow2

Product Availability

Available with ArcGIS Desktop.

Method Summary

int	getHWnd() The window's handle.
boolean	isDockable() Indicates if the window is dockable.
boolean	isVisible() Indicates if the window is visible.
void	putPosition(int left, int top, int right, int bottom) The window's position in screen pixels.
void	queryPosition(int[] left, int[] top, int[] right, int[] bottom) The window's position in screen pixels.
void	refresh() Cause the window to redraw.
void	setApplicationByRef(Object rhs1) Provides the window with a reference to the application.
void	show(boolean show) Indicates if the window is shown.

Method Detail

setApplicationByRef

void setApplicationByRef(Object rhs1)
                         throws IOException,
                                AutomationException

Provides the window with a reference to the application.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to another Automation Object (IDispatch) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException

The window's handle.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryPosition

void queryPosition(int[] left,
                   int[] top,
                   int[] right,
                   int[] bottom)
                   throws IOException,
                          AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

left - The left (out: use single element array)

top - The top (out: use single element array)

right - The right (out: use single element array)

bottom - The bottom (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putPosition

void putPosition(int left,
                 int top,
                 int right,
                 int bottom)
                 throws IOException,
                        AutomationException

The window's position in screen pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

left - The left (in)

top - The top (in)

right - The right (in)

bottom - The bottom (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the window is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDockable

boolean isDockable()
                   throws IOException,
                          AutomationException

Indicates if the window is dockable.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show(boolean show)
          throws IOException,
                 AutomationException

Indicates if the window is shown.

Description

Show specifies whether the data 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.

refresh

void refresh()
             throws IOException,
                    AutomationException

Cause the window to redraw.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.