com.esri.arcgis.arcmapui
Interface IDataConnectionPropertyPage2

All Superinterfaces:

Serializable

All Known Implementing Classes:

DataConnectionPropertyPage

public interface IDataConnectionPropertyPage2
extends Serializable

Provides access to members that control the Data connection property page.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	attemptToDeleteExistingName() For save dialogs, attempt to delete the table/feature class.
String	getBrowseLocation() Last location of the GxDialog.
IDatasetFilter	getDatasetFilter() Filter (optional) for the page.
IGxObjectFilter	getDialogFilter() Filter (optional) for the GxDialog.
IName	getName() User selected Name (ie, FeatureClassName, TableName).
void	selectName(IName name) Selects the name from the list.
void	setBrowseLocation(String filter) Last location of the GxDialog.
void	setCallback(IDataConnectionCallback rhs1) Callback implementation (not mandatory).
void	setDatasetFilterByRef(IDatasetFilter filter) Filter (optional) for the page.
void	setDefaultName(String rhs1) Default name when NewDataFile is true.
void	setDialogFilterByRef(IGxObjectFilter filter) Filter (optional) for the GxDialog.
void	setEnabled(boolean rhs1) Indicates if all the window controls in the property page are enabled.
void	setFocus() Sets the focus to the file name window.
void	setNewDataFile(boolean rhs1) Indicates if the dialog is for new data.
void	setPromptName(String rhs1) Prompt name.
void	setReturnDisplayTableName(boolean rhs1) Indicates if a raw FDO or a display table name is returned when get_Name method is called.
void	setShowDropdown(boolean rhs1) Indicates if existing data is shown in a dropdown.
void	setShowNone(boolean rhs1) Indicates if the option is shown in a dropdown.
void	setSkipByRef(ITable rhs1) When NewDataFile is false, skip this table/featureclass in the ComboBox.
void	setType(int rhs1) Type of data we are getting or putting.
void	setUniqueDefaultName(String baseName) A Unique Default name when NewDataFile is true.

Method Detail

setEnabled

void setEnabled(boolean rhs1)
                throws IOException,
                       AutomationException

Indicates if all the window controls in the property page are enabled.

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.

setNewDataFile

void setNewDataFile(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates if the dialog is for new data.

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.

setDefaultName

void setDefaultName(String rhs1)
                    throws IOException,
                           AutomationException

Default name when NewDataFile is true.

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.

setPromptName

void setPromptName(String rhs1)
                   throws IOException,
                          AutomationException

Prompt name. Default is to use 'Save As:' for saving and 'Choose:' for loading.

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.

setType

void setType(int rhs1)
             throws IOException,
                    AutomationException

Type of data we are getting or putting.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A com.esri.arcgis.arcmapui.esriDCType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

IName getName()
              throws IOException,
                     AutomationException

User selected Name (ie, FeatureClassName, TableName).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSkipByRef

void setSkipByRef(ITable rhs1)
                  throws IOException,
                         AutomationException

When NewDataFile is false, skip this table/featureclass in the ComboBox.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

attemptToDeleteExistingName

void attemptToDeleteExistingName()
                                 throws IOException,
                                        AutomationException

For save dialogs, attempt to delete the table/feature class. Returns successfully if the object is delete, S_FALSE if the user requested no, or the delete error.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallback

void setCallback(IDataConnectionCallback rhs1)
                 throws IOException,
                        AutomationException

Callback implementation (not mandatory).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to a com.esri.arcgis.arcmapui.IDataConnectionCallback (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBrowseLocation

void setBrowseLocation(String filter)
                       throws IOException,
                              AutomationException

Last location of the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

filter - The filter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseLocation

String getBrowseLocation()
                         throws IOException,
                                AutomationException

Last location of the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectName

void selectName(IName name)
                throws IOException,
                       AutomationException

Selects the name from the list.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFocus

void setFocus()
              throws IOException,
                     AutomationException

Sets the focus to the file name window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetFilterByRef

void setDatasetFilterByRef(IDatasetFilter filter)
                           throws IOException,
                                  AutomationException

Filter (optional) for the page. Determines what datasets are visible.

Product Availability

Available with ArcGIS Desktop.

Parameters:

filter - A reference to a com.esri.arcgis.arcmapui.IDatasetFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetFilter

IDatasetFilter getDatasetFilter()
                                throws IOException,
                                       AutomationException

Filter (optional) for the page. Determines what datasets are visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.arcmapui.IDatasetFilter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDialogFilterByRef

void setDialogFilterByRef(IGxObjectFilter filter)
                          throws IOException,
                                 AutomationException

Filter (optional) for the GxDialog.

Product Availability

Available with ArcGIS Desktop.

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.

getDialogFilter

IGxObjectFilter getDialogFilter()
                                throws IOException,
                                       AutomationException

Filter (optional) for the GxDialog.

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.

setUniqueDefaultName

void setUniqueDefaultName(String baseName)
                          throws IOException,
                                 AutomationException

A Unique Default name when NewDataFile is true.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

baseName - The baseName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowDropdown

void setShowDropdown(boolean rhs1)
                     throws IOException,
                            AutomationException

Indicates if existing data is shown in a dropdown.

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.

setShowNone

void setShowNone(boolean rhs1)
                 throws IOException,
                        AutomationException

Indicates if the option is shown in a dropdown.

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.

setReturnDisplayTableName

void setReturnDisplayTableName(boolean rhs1)
                               throws IOException,
                                      AutomationException

Indicates if a raw FDO or a display table name is returned when get_Name method is called.

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.