com.esri.arcgis.framework
Interface IGetStringDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

GetStringDialog

public interface IGetStringDialog
extends Serializable

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

Remarks

The get string dialog is a dialog used for getting user input in the form of a string.

To get access to the IGetStringDialog interface, create a new GetStringDialog object.

The following code shows a GetStringDialog and reports the string value that was entered in the dialog. You would get m_app from the hook in ICommand::OnCreate().

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	doModal(String dialogTitle, String getStringLabel, String initialValue, int hWnd) Shows the dialog.
String	getValue() The value of the string.

Method Detail

getValue

String getValue()
                throws IOException,
                       AutomationException

The value of the string.

Remarks

The Value property allows you to get the value of the string 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 dialogTitle,
                String getStringLabel,
                String initialValue,
                int hWnd)
                throws IOException,
                       AutomationException

Shows the dialog.

Description

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

getStringLabel specifies the label for the string.

initialValue specifies the intial value of the string to be displayed in the dialog.

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

Remarks

If the dialog was cancelled, the DoModal method returns False.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dialogTitle - The dialogTitle (in)

getStringLabel - The getStringLabel (in)

initialValue - The initialValue (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.