com.esri.arcgis.framework
Class GetUserAndPasswordDialog

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

All Implemented Interfaces:

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

public class GetUserAndPasswordDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGetUserAndPasswordDialog

A dialog used for getting user and password information.

Remarks

The get user and password dialog is a dialog used for getting username and password information.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GetUserAndPasswordDialog()
Constructs a GetUserAndPasswordDialog using ArcGIS Engine.

GetUserAndPasswordDialog(Object obj)
Construct a GetUserAndPasswordDialog using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	doModal(String dialogTitle, String stringLabel, int hWnd) Shows the dialog.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getPassword() The password entered in the dialog.
String	getUserName() The user name entered in the dialog.
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

GetUserAndPasswordDialog

public GetUserAndPasswordDialog()
                         throws IOException,
                                UnknownHostException

Constructs a GetUserAndPasswordDialog using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GetUserAndPasswordDialog

public GetUserAndPasswordDialog(Object obj)
                         throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems GetUserAndPasswordDialog theGetUserAndPasswordDialog = (GetUserAndPasswordDialog) obj;

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

getUserName

public String getUserName()
                   throws IOException,
                          AutomationException

The user name entered in the dialog.

Remarks

The UserName property allows you to get the username that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getUserName in interface IGetUserAndPasswordDialog

Returns:

The userName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPassword

public String getPassword()
                   throws IOException,
                          AutomationException

The password entered in the dialog.

Remarks

The Password property allows you to get the password that was entered in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPassword in interface IGetUserAndPasswordDialog

Returns:

The password

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

public boolean doModal(String dialogTitle,
                       String stringLabel,
                       int hWnd)
                throws IOException,
                       AutomationException

Shows the dialog.

Description

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

stringLabel specifies the label for 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 IGetUserAndPasswordDialog

Parameters:

dialogTitle - The dialogTitle (in)

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