com.esri.arcgis.arcmapui
Interface IDataWindow2

All Superinterfaces:

Serializable

All Known Implementing Classes:

IDataWindow2Proxy, ImageInsetWindow, MapInsetWindow, OverviewWindow, TableWindow

public interface IDataWindow2
extends Serializable

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

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	destroy() Close and destroy the window.
int	getHWnd() The window's handle.
String	getTag() For developer use.
boolean	isDockable() Indicates if the window is dockable.
boolean	isEnableContextMenu() Indicates if the context menu should be enabled.
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	setEnableContextMenu(boolean enable) Indicates if the context menu should be enabled.
void	setTag(String tag) For developer use.
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.

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.

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.

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.

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.

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.

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.

Product Availability

Available with ArcGIS Desktop.

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.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTag

String getTag()
              throws IOException,
                     AutomationException

For developer use.

Product Availability

Available with ArcGIS Desktop.

Returns:

The tag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTag

void setTag(String tag)
            throws IOException,
                   AutomationException

For developer use.

Product Availability

Available with ArcGIS Desktop.

Parameters:

tag - The tag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnableContextMenu

boolean isEnableContextMenu()
                            throws IOException,
                                   AutomationException

Indicates if the context menu should be enabled.

Product Availability

Available with ArcGIS Desktop.

Returns:

The enable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnableContextMenu

void setEnableContextMenu(boolean enable)
                          throws IOException,
                                 AutomationException

Indicates if the context menu should be enabled.

Product Availability

Available with ArcGIS Desktop.

Parameters:

enable - The enable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

destroy

void destroy()
             throws IOException,
                    AutomationException

Close and destroy the window.

Product Availability

Available with ArcGIS Desktop.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.