com.esri.arcgis.catalogUI
Class IGxDialogProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.catalogUI.IGxDialogProxy

All Implemented Interfaces:

IGxDialog, Externalizable, Serializable

public class IGxDialogProxy
extends com.esri.arcgis.interop.Dispatch
implements IGxDialog, Serializable

Provides access to members that control the GxDialog.

Description

The IGxDialog interface is implemented by the GxDialog object and provides access to the properties of the dialog box object and methods for displaying the dialog box during open or save operations. Use this interface when you want to access the properties of the dialog box or when you wish to display the dialog box for input from the end user.

What the user can select or specify when using a GxDialog browser is based on the filters (GxObjectFilter) held by the object. The GxDialog object implements the IGxObjectFilterCollection interface. It provides access to the set of filters used by the GxDialog object. Even though a collection of filters can be attached to a GxDialog object, onlyone filter is actually active at a time. The active filter is specified through the dialog box when DoModalOpen or DoModalSave is executed through the IGxDialog interface. Use the IGxObjectFilterCollection interface when you want to remove all of the filters or when you want to add an additional filter to the object.

Remarks

If you are writing an application in Visual C++ that creates/uses a GxDialog object, the application needs to call ::OleInitialize() instead of ::CoInitialize() prior to creating the GxDialog.

When To Use

Use the IGxDialog interface when you want to invoke a dialog to pick one or more GIS datasets or to save GIS data to disk.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
boolean	doModalOpen(int parentWindow, IEnumGxObject[] selection) Opens the dialog to choose data.
boolean	doModalSave(int parentWindow) Opens the dialog to save data.
IGxObject	getFinalLocation() The dialog's final location.
IGxCatalog	getInternalCatalog() The catalog object used internally by the GxDialog.
String	getName() The text in the Name text box (only for DoModalSave).
IGxObjectFilter	getObjectFilter() The object filter.
boolean	isReplacingObject() Indicates if an object already exists with the name supplied by the user, and is being replaced.
void	removeListener(String iidStr, Object theListener)
void	setAllowMultiSelect(boolean rhs1) Indicates if multiple items may be selected.
void	setButtonCaption(String rhs1) The caption to use for the Open or Save button.
void	setName(String name) The text in the Name text box (only for DoModalSave).
void	setObjectFilterByRef(IGxObjectFilter filter) The object filter.
void	setRememberLocation(boolean rhs1) Indicates if the dialog should use the final location as the next starting location.
void	setStartingLocation(Object rhs1) The dialog's starting location.
void	setTitle(String rhs1) The dialog's title.

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

IGxDialogProxy

public IGxDialogProxy()

IGxDialogProxy

public IGxDialogProxy(Object obj)
               throws IOException

Throws:

IOException

IGxDialogProxy

protected IGxDialogProxy(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

setAllowMultiSelect

public void setAllowMultiSelect(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if multiple items may be selected. False, by default.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAllowMultiSelect in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String rhs1)
              throws IOException,
                     AutomationException

The dialog's title.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTitle in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setButtonCaption

public void setButtonCaption(String rhs1)
                      throws IOException,
                             AutomationException

The caption to use for the Open or Save button.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setButtonCaption in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The text in the Name text box (only for DoModalSave).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setName in interface IGxDialog

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The text in the Name text box (only for DoModalSave).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxDialog

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplacingObject

public boolean isReplacingObject()
                          throws IOException,
                                 AutomationException

Indicates if an object already exists with the name supplied by the user, and is being replaced.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isReplacingObject in interface IGxDialog

Returns:

The replacingObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingLocation

public void setStartingLocation(Object rhs1)
                         throws IOException,
                                AutomationException

The dialog's starting location. This can be an IGxObject or a text-string containing the full name of an object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setStartingLocation in interface IGxDialog

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFinalLocation

public IGxObject getFinalLocation()
                           throws IOException,
                                  AutomationException

The dialog's final location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getFinalLocation in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRememberLocation

public void setRememberLocation(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if the dialog should use the final location as the next starting location. True, by default.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setRememberLocation in interface IGxDialog

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

public void setObjectFilterByRef(IGxObjectFilter filter)
                          throws IOException,
                                 AutomationException

The object filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setObjectFilterByRef in interface IGxDialog

Parameters:

filter - A reference to a com.esri.arcgis.catalog.IGxObjectFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectFilter

public IGxObjectFilter getObjectFilter()
                                throws IOException,
                                       AutomationException

The object filter.

Remarks

ObjectFilter will return the filter that is currently active in the dialog. If the dialog is not currently open (through DoModalOpen or DoModalSave), then this property will return the default filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getObjectFilter in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxObjectFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalCatalog

public IGxCatalog getInternalCatalog()
                              throws IOException,
                                     AutomationException

The catalog object used internally by the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getInternalCatalog in interface IGxDialog

Returns:

A reference to a com.esri.arcgis.catalog.IGxCatalog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModalOpen

public boolean doModalOpen(int parentWindow,
                           IEnumGxObject[] selection)
                    throws IOException,
                           AutomationException

Opens the dialog to choose data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModalOpen in interface IGxDialog

Parameters:

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

selection - A reference to a com.esri.arcgis.catalog.IEnumGxObject (out: use single element array)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModalSave

public boolean doModalSave(int parentWindow)
                    throws IOException,
                           AutomationException

Opens the dialog to save data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

doModalSave in interface IGxDialog

Parameters:

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

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.