com.esri.arcgis.framework
Interface IWindowPosition

All Superinterfaces:
Serializable
All Known Implementing Classes:
Application, Application, Application, Application, CommandBar, DockableWindow, IWindowPositionProxy, ModelessFrame

public interface IWindowPosition
extends Serializable

Provides access to members that query or modify a window's position, size and state.

Remarks

The IWindowPosition interface has methods to move and resize a window. Any window object can implement this interface. All the ArcGIS application windows implement this interface.

Commandbars also support IWindowPostion. Use the State property to determine whether a toolbar is floating on the desktop.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 int getHeight()
          The height of the window.
 int getLeft()
          The distance between the internal left edge of the window and screen.
 int getState()
          The state of the window.
 int getTop()
          The distance between the internal top edge of the window and screen.
 int getWidth()
          The width of the window.
 void move(int left, int top, int width, int height)
          Moves and optionally resizes the windows in a single function.
 void setHeight(int height)
          The height of the window.
 void setLeft(int left)
          The distance between the internal left edge of the window and screen.
 void setState(int windowState)
          The state of the window.
 void setTop(int top)
          The distance between the internal top edge of the window and screen.
 void setWidth(int width)
          The width of the window.
 

Method Detail

setLeft

void setLeft(int left)
             throws IOException,
                    AutomationException
The distance between the internal left edge of the window and screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
left - The left (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLeft

int getLeft()
            throws IOException,
                   AutomationException
The distance between the internal left edge of the window and screen.

Remarks

The Left property determines the position of the window in screen coordinates relative to the upper-left corner of the display screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setTop

void setTop(int top)
            throws IOException,
                   AutomationException
The distance between the internal top edge of the window and screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
top - The top (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTop

int getTop()
           throws IOException,
                  AutomationException
The distance between the internal top edge of the window and screen.

Remarks

The Top property determines the position of the window in screen coordinates relative to the upper-left corner of the display screen.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setWidth

void setWidth(int width)
              throws IOException,
                     AutomationException
The width of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
width - The width (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWidth

int getWidth()
             throws IOException,
                    AutomationException
The width of the window.

Remarks

The Height and Width properties determine the size of the window. This is in screen units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setHeight

void setHeight(int height)
               throws IOException,
                      AutomationException
The height of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
height - The height (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHeight

int getHeight()
              throws IOException,
                     AutomationException
The height of the window.

Remarks

The Height and Width properties determine the size of the window. This is in screen units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

move

void move(int left,
          int top,
          int width,
          int height)
          throws IOException,
                 AutomationException
Moves and optionally resizes the windows in a single function.

Remarks

You can use the Move method to set the Left, Top, Width, and Height properties all at the same time.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
left - The left (in)
top - The top (in)
width - The width (in, optional, pass 0 if not required)
height - The height (in, optional, pass 0 if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setState

void setState(int windowState)
              throws IOException,
                     AutomationException
The state of the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
windowState - A com.esri.arcgis.framework.esriWindowState constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

int getState()
             throws IOException,
                    AutomationException
The state of the window.

Remarks

The State property uses the esriWindowState enumeration to specify whether the window is normal, minimized, or maximized.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:
A com.esri.arcgis.framework.esriWindowState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.