com.esri.arcgis.framework
Interface ICoordinateDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

CoordinateDialog

public interface ICoordinateDialog
extends Serializable

Provides access to members that work with a dialog for getting coordinates.

Remarks

The coordinate dialog is a dialog used for getting user input in the form of X and Y coordinates.

To get access to the ICoordinateDialog interface you would create a new CoordinateDialog object.

The following code shows a CoordinateDialog and reports the X and Y values. You would get m_app from the hook in ICommand::OnCreate() .

Product Availability

Available with ArcGIS Desktop.

See Also:

NumberDialog, INumberDialog

Method Summary

boolean	doModal(String title, double initialX, double initialY, int numDecs, int hWnd) Shows the dialog.
double	getX() The X value entered in the dialog.
double	getY() The Y value entered in the dialog.

Method Detail

getX

double getX()
            throws IOException,
                   AutomationException

The X value entered in the dialog.

Remarks

The X property allows you to get the X value that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getY

double getY()
            throws IOException,
                   AutomationException

The Y value entered in the dialog.

Remarks

The Y property allows you to get the Y value that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

boolean doModal(String title,
                double initialX,
                double initialY,
                int numDecs,
                int hWnd)
                throws IOException,
                       AutomationException

Shows the dialog.

Description

Title is a string that specifies the title of the dialog.

initialX specifies the intial value of X to be displayed in the dialog.

initialY specifies the intial value of Y to be displayed in the dialog.

numDecs specifies the number of decimal places to be used for the values.

hWnd specifies the window handle of the parent window. In most cases this will be the hWnd of the application.

Remarks

If non-numeric values were entered or if the dialog was cancelled, the DoModal method returns False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

title - The title (in)

initialX - The initialX (in)

initialY - The initialY (in)

numDecs - The numDecs (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

The okPressed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.