com.esri.arcgis.catalogUI
Interface IGxDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

GxDialog, IGxDialogProxy

public interface IGxDialog
extends 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.

Method Summary

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	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.

Method Detail

setAllowMultiSelect

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(String rhs1)
              throws IOException,
                     AutomationException

The dialog's title.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setButtonCaption

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReplacingObject

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

Returns:

The replacingObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingLocation

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

Parameters:

rhs1 - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFinalLocation

IGxObject getFinalLocation()
                           throws IOException,
                                  AutomationException

The dialog's final location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectFilterByRef

void setObjectFilterByRef(IGxObjectFilter filter)
                          throws IOException,
                                 AutomationException

The object filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

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

IGxCatalog getInternalCatalog()
                              throws IOException,
                                     AutomationException

The catalog object used internally by the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

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

Opens the dialog to choose data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

boolean doModalSave(int parentWindow)
                    throws IOException,
                           AutomationException

Opens the dialog to save data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.