com.esri.arcgis.datainterop
Interface IDatasourceUtilUI

All Superinterfaces:
Serializable
All Known Implementing Classes:
DatasourceUtilUI, IDatasourceUtilUIProxy

public interface IDatasourceUtilUI
extends Serializable

IDatasourceUtilUI Interface

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 void dialogWithHelp(String title, String message, String dismissLabel, String helpLabel, String helpFile, String helpTopic)
          method DialogWithHelp
 void dialogWithHelpUsingResources(int title, int message, String helpFile, String helpTopic)
          method DialogWithHelpUsingResources
 void extensionNotEnabledDialog(boolean showUnconditionally)
          method ExtensionNotEnabledDialog
 void extensionShutdown()
          method ExtensionShutdown
 void extensionStartup(Object initializationData)
          method ExtensionStartup
 String getApplicationName()
          property ApplicationName
 boolean isApplication()
          property IsApplication
 boolean isArcCatalog()
          property IsArcCatalog
 void messageDialog(String title, String message, String dismissLabel)
          method MessageDialog
 void messageDialogUsingResources(int title, int message)
          method MessageDialogUsingResources
 void messageStatus(String message)
          method MessageStatus
 void progressCreate(String title, String description)
          method ProgressCreate
 void progressDestroy()
          method ProgressDestroy
 void progressQuery(boolean[] keepGoing)
          method ProgressQuery
 void progressUpdate(String message)
          method ProgressUpdate
 void resetAllDatasets()
          method ResetAllDatasets
 void setDialogsPermitted(boolean rhs1)
          property DialogsPermitted
 void setRootObjectVisibility(boolean showRoot)
          method SetRootObjectVisibility
 

Method Detail

extensionStartup

void extensionStartup(Object initializationData)
                      throws IOException,
                             AutomationException
method ExtensionStartup

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
initializationData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extensionShutdown

void extensionShutdown()
                       throws IOException,
                              AutomationException
method ExtensionShutdown

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isApplication

boolean isApplication()
                      throws IOException,
                             AutomationException
property IsApplication

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The isApp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isArcCatalog

boolean isArcCatalog()
                     throws IOException,
                            AutomationException
property IsArcCatalog

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The isArcCat
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getApplicationName

String getApplicationName()
                          throws IOException,
                                 AutomationException
property ApplicationName

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDialogsPermitted

void setDialogsPermitted(boolean rhs1)
                         throws IOException,
                                AutomationException
property DialogsPermitted

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

extensionNotEnabledDialog

void extensionNotEnabledDialog(boolean showUnconditionally)
                               throws IOException,
                                      AutomationException
method ExtensionNotEnabledDialog

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
showUnconditionally - The showUnconditionally (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetAllDatasets

void resetAllDatasets()
                      throws IOException,
                             AutomationException
method ResetAllDatasets

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRootObjectVisibility

void setRootObjectVisibility(boolean showRoot)
                             throws IOException,
                                    AutomationException
method SetRootObjectVisibility

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
showRoot - The showRoot (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dialogWithHelpUsingResources

void dialogWithHelpUsingResources(int title,
                                  int message,
                                  String helpFile,
                                  String helpTopic)
                                  throws IOException,
                                         AutomationException
method DialogWithHelpUsingResources

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
title - The title (in)
message - The message (in)
helpFile - The helpFile (in)
helpTopic - The helpTopic (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

dialogWithHelp

void dialogWithHelp(String title,
                    String message,
                    String dismissLabel,
                    String helpLabel,
                    String helpFile,
                    String helpTopic)
                    throws IOException,
                           AutomationException
method DialogWithHelp

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
title - The title (in)
message - The message (in)
dismissLabel - The dismissLabel (in)
helpLabel - The helpLabel (in)
helpFile - The helpFile (in)
helpTopic - The helpTopic (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

messageDialogUsingResources

void messageDialogUsingResources(int title,
                                 int message)
                                 throws IOException,
                                        AutomationException
method MessageDialogUsingResources

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
title - The title (in)
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

messageDialog

void messageDialog(String title,
                   String message,
                   String dismissLabel)
                   throws IOException,
                          AutomationException
method MessageDialog

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
title - The title (in)
message - The message (in)
dismissLabel - The dismissLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

messageStatus

void messageStatus(String message)
                   throws IOException,
                          AutomationException
method MessageStatus

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

progressCreate

void progressCreate(String title,
                    String description)
                    throws IOException,
                           AutomationException
method ProgressCreate

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
title - The title (in)
description - The description (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

progressUpdate

void progressUpdate(String message)
                    throws IOException,
                           AutomationException
method ProgressUpdate

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
message - The message (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

progressQuery

void progressQuery(boolean[] keepGoing)
                   throws IOException,
                          AutomationException
method ProgressQuery

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
keepGoing - The keepGoing (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

progressDestroy

void progressDestroy()
                     throws IOException,
                            AutomationException
method ProgressDestroy

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.