com.esri.arcgis.framework
Class GetStringDialog

java.lang.Object
  com.esri.arcgis.framework.GetStringDialog

All Implemented Interfaces:

IGetStringDialog, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GetStringDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGetStringDialog

A dialog used for getting a string.

Remarks

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GetStringDialog()
Constructs a GetStringDialog using ArcGIS Engine.

GetStringDialog(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GetStringDialog theGetStringDialog = (GetStringDialog) obj;

Method Summary

boolean	doModal(String dialogTitle, String getStringLabel, String initialValue, int hWnd) Shows the dialog.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getValue() The value of the string.
int	hashCode() the hashcode for this object

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GetStringDialog

public GetStringDialog()
                throws IOException,
                       UnknownHostException

Constructs a GetStringDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GetStringDialog

public GetStringDialog(Object obj)
                throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GetStringDialog theGetStringDialog = (GetStringDialog) obj;

Construct a GetStringDialog using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GetStringDialog.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getValue

public 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

Specified by:

getValue in interface IGetStringDialog

Returns:

The val

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public 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

Specified by:

doModal in interface IGetStringDialog

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.