com.esri.arcgis.framework
Class IGetUserAndPasswordDialogProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.IGetUserAndPasswordDialogProxy

All Implemented Interfaces:

IGetUserAndPasswordDialog, Externalizable, Serializable

public class IGetUserAndPasswordDialogProxy
extends com.esri.arcgis.interop.Dispatch
implements IGetUserAndPasswordDialog, Serializable

Provides access to members that work with a dialog for getting user and password information.

Remarks

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

To get access to the IGetUserAndPasswordDialog interface, create a new GetUserAndPasswordDialog object.

The following code shows a GetUserAndPassword dialog and validates the username and password that was entered in the dialog. You would get m_app from the hook in ICommand::OnCreate().

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IGetUserAndPasswordDialogProxy()
	IGetUserAndPasswordDialogProxy(Object obj)
protected	IGetUserAndPasswordDialogProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	doModal(String dialogTitle, String stringLabel, int hWnd) Shows the dialog.
String	getPassword() The password entered in the dialog.
String	getUserName() The user name entered in the dialog.
void	removeListener(String iidStr, Object theListener)

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IGetUserAndPasswordDialogProxy

public IGetUserAndPasswordDialogProxy()

IGetUserAndPasswordDialogProxy

public IGetUserAndPasswordDialogProxy(Object obj)
                               throws IOException

Throws:

IOException

IGetUserAndPasswordDialogProxy

protected IGetUserAndPasswordDialogProxy(Object obj,
                                         String iid)
                                  throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

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.