com.esri.arcgis.arcmapui
Class DataConnectionPropertyPage

java.lang.Object
  com.esri.arcgis.arcmapui.DataConnectionPropertyPage

All Implemented Interfaces:

IDataConnectionPropertyPage, IDataConnectionPropertyPage2, IComPropertyPage, IComPropertyPage2, IPropertyPage, IPropertyPageContext, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DataConnectionPropertyPage
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataConnectionPropertyPage, IDataConnectionPropertyPage2, IPropertyPage, IPropertyPageContext, IComPropertyPage2, IComPropertyPage

Data Connection Property Page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.framework.IComPropertyPage

IID, IID76951cc6_dbb1_11d2_b868_00600802e603, xxDummy

Constructor Summary

DataConnectionPropertyPage()
Constructs a DataConnectionPropertyPage using ArcGIS Engine.

DataConnectionPropertyPage(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataConnectionPropertyPage theDataConnectionPropertyPage = (DataConnectionPropertyPage) obj;

Method Summary

void	activate(_RemotableHandle hWndParent, tagRECT pRect, int bModal) activate
int	activate() Occurs on page creation.
boolean	applies(ISet objects) Indicates if the page applies to the specified objects.
boolean	applies(Object unkArray) Check if property page applies to the specified set of objects.
void	apply() apply
void	attemptToDeleteExistingName() For save dialogs, attempt to delete the table/feature class.
void	cancel() Property sheet calls this when cancel button is pressed.
Object	createCompatibleObject(Object kind) Create a new object using the specified object as a template.
void	deactivate() deactivate
boolean	equals(Object o) Compare this object with another
String	getBrowseLocation() Last location of the GxDialog.
static String	getClsid() getClsid.
IDatasetFilter	getDatasetFilter() Filter (optional) for the page.
IGxObjectFilter	getDialogFilter() Filter (optional) for the GxDialog.
int	getHeight() The height of the page in pixels.
int	getHelpContextID(int controlID) The help context ID for the specified control on the page.
String	getHelpFile() The help file name for the page.
String	getHelpFile(int controlID) Returns the help file name for the specified control.
int	getHelpId(int controlID) Returns the help ID for the specified control.
IName	getName() User selected Name (ie, FeatureClassName, TableName).
void	getPageInfo(tagPROPPAGEINFO[] pPageInfo) getPageInfo
int	getPriority() The page's priority relative to other pages that interact with the same object.
String	getTitle() The title of the property page.
int	getWidth() The width of the page in pixels.
int	hashCode() the hashcode for this object
void	help(String pszHelpDir) help
void	hide() Hides the page.
boolean	IComPropertyPage_isPageDirty() Indicates if the page made any changes to the object(s).
boolean	IComPropertyPage2_isPageDirty() Indicates if the page made any changes to the object(s).
void	isPageDirty() isPageDirty
void	move(tagRECT pRect) move
boolean	queryCancel() Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.
void	queryObject(Object theObject) Apply the property page settings to the specified object.
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	setObjects(int cObjects, Object[] ppUnk) setObjects
void	setObjects(ISet objects) Supplies the page with the object(s) to be edited.
void	setPageSite(IPropertyPageSite pPageSite) setPageSite
void	setPageSiteByRef(IComPropertyPageSite rhs1) The sheet that contains the page.
void	setPriority(int priority) The page priority.
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	setTitle(String title) The title of the property page.
void	setType(int rhs1) Type of data we are getting or putting.
void	setUniqueDefaultName(String baseName) A Unique Default name when NewDataFile is true.
void	show() Shows the page.
void	show(int nCmdShow) show
void	translateAccelerator(tagMSG pMsg) translateAccelerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DataConnectionPropertyPage

public DataConnectionPropertyPage()
                           throws IOException,
                                  UnknownHostException

Constructs a DataConnectionPropertyPage using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DataConnectionPropertyPage

public DataConnectionPropertyPage(Object obj)
                           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DataConnectionPropertyPage theDataConnectionPropertyPage = (DataConnectionPropertyPage) obj;

Construct a DataConnectionPropertyPage using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DataConnectionPropertyPage.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setEnabled

public 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

Specified by:

setEnabled in interface IDataConnectionPropertyPage

Specified by:

setEnabled in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNewDataFile

public void setNewDataFile(boolean rhs1)
                    throws IOException,
                           AutomationException

Indicates if the dialog is for new data.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setNewDataFile in interface IDataConnectionPropertyPage

Specified by:

setNewDataFile in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultName

public void setDefaultName(String rhs1)
                    throws IOException,
                           AutomationException

Default name when NewDataFile is true.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDefaultName in interface IDataConnectionPropertyPage

Specified by:

setDefaultName in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPromptName

public 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

Specified by:

setPromptName in interface IDataConnectionPropertyPage

Specified by:

setPromptName in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(int rhs1)
             throws IOException,
                    AutomationException

Type of data we are getting or putting.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setType in interface IDataConnectionPropertyPage

Specified by:

setType in interface IDataConnectionPropertyPage2

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

public IName getName()
              throws IOException,
                     AutomationException

User selected Name (ie, FeatureClassName, TableName).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IDataConnectionPropertyPage

Specified by:

getName in interface IDataConnectionPropertyPage2

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

public void setSkipByRef(ITable rhs1)
                  throws IOException,
                         AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSkipByRef in interface IDataConnectionPropertyPage

Specified by:

setSkipByRef in interface IDataConnectionPropertyPage2

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

public 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

Specified by:

attemptToDeleteExistingName in interface IDataConnectionPropertyPage

Specified by:

attemptToDeleteExistingName in interface IDataConnectionPropertyPage2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCallback

public void setCallback(IDataConnectionCallback rhs1)
                 throws IOException,
                        AutomationException

Callback implementation (not mandatory).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCallback in interface IDataConnectionPropertyPage

Specified by:

setCallback in interface IDataConnectionPropertyPage2

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

public void setBrowseLocation(String filter)
                       throws IOException,
                              AutomationException

Last location of the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setBrowseLocation in interface IDataConnectionPropertyPage2

Parameters:

filter - The filter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBrowseLocation

public String getBrowseLocation()
                         throws IOException,
                                AutomationException

Last location of the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getBrowseLocation in interface IDataConnectionPropertyPage2

Returns:

The filter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectName

public void selectName(IName name)
                throws IOException,
                       AutomationException

Selects the name from the list.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

selectName in interface IDataConnectionPropertyPage2

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

public void setFocus()
              throws IOException,
                     AutomationException

Sets the focus to the file name window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setFocus in interface IDataConnectionPropertyPage2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetFilterByRef

public void setDatasetFilterByRef(IDatasetFilter filter)
                           throws IOException,
                                  AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDatasetFilterByRef in interface IDataConnectionPropertyPage2

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

public IDatasetFilter getDatasetFilter()
                                throws IOException,
                                       AutomationException

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDatasetFilter in interface IDataConnectionPropertyPage2

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

public void setDialogFilterByRef(IGxObjectFilter filter)
                          throws IOException,
                                 AutomationException

Filter (optional) for the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDialogFilterByRef in interface IDataConnectionPropertyPage2

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

public IGxObjectFilter getDialogFilter()
                                throws IOException,
                                       AutomationException

Filter (optional) for the GxDialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDialogFilter in interface IDataConnectionPropertyPage2

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

public void setUniqueDefaultName(String baseName)
                          throws IOException,
                                 AutomationException

A Unique Default name when NewDataFile is true.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setUniqueDefaultName in interface IDataConnectionPropertyPage2

Parameters:

baseName - The baseName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowDropdown

public 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

Specified by:

setShowDropdown in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowNone

public 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

Specified by:

setShowNone in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDisplayTableName

public 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

Specified by:

setReturnDisplayTableName in interface IDataConnectionPropertyPage2

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageSite

public void setPageSite(IPropertyPageSite pPageSite)
                 throws IOException,
                        AutomationException

setPageSite

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPageSite in interface IPropertyPage

Parameters:

pPageSite - A reference to a com.esri.arcgis.framework.IPropertyPageSite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public void activate(_RemotableHandle hWndParent,
                     tagRECT pRect,
                     int bModal)
              throws IOException,
                     AutomationException

activate

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activate in interface IPropertyPage

Parameters:

hWndParent - A Structure: com.esri.arcgis.framework._RemotableHandle (A com.esri.arcgis.framework._RemotableHandle COM typedef) (in)

pRect - A Structure: com.esri.arcgis.system.tagRECT (in)

bModal - The bModal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deactivate

public void deactivate()
                throws IOException,
                       AutomationException

deactivate

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

deactivate in interface IComPropertyPage

Specified by:

deactivate in interface IComPropertyPage2

Specified by:

deactivate in interface IPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPageInfo

public void getPageInfo(tagPROPPAGEINFO[] pPageInfo)
                 throws IOException,
                        AutomationException

getPageInfo

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPageInfo in interface IPropertyPage

Parameters:

pPageInfo - A Structure: com.esri.arcgis.framework.tagPROPPAGEINFO (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjects

public void setObjects(int cObjects,
                       Object[] ppUnk)
                throws IOException,
                       AutomationException

setObjects

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setObjects in interface IPropertyPage

Parameters:

cObjects - The cObjects (in)

ppUnk - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show(int nCmdShow)
          throws IOException,
                 AutomationException

show

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IPropertyPage

Parameters:

nCmdShow - The nCmdShow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public void move(tagRECT pRect)
          throws IOException,
                 AutomationException

move

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

move in interface IPropertyPage

Parameters:

pRect - A Structure: com.esri.arcgis.system.tagRECT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPageDirty

public void isPageDirty()
                 throws IOException,
                        AutomationException

isPageDirty

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

isPageDirty in interface IPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public void apply()
           throws IOException,
                  AutomationException

apply

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

apply in interface IComPropertyPage

Specified by:

apply in interface IComPropertyPage2

Specified by:

apply in interface IPropertyPage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

help

public void help(String pszHelpDir)
          throws IOException,
                 AutomationException

help

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

help in interface IPropertyPage

Parameters:

pszHelpDir - A String (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

translateAccelerator

public void translateAccelerator(tagMSG pMsg)
                          throws IOException,
                                 AutomationException

translateAccelerator

Description

IPropertyPage is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

translateAccelerator in interface IPropertyPage

Parameters:

pMsg - A Structure: com.esri.arcgis.framework.tagMSG (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException

The page's priority relative to other pages that interact with the same object. The higher the value, the higher the priority.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getPriority in interface IComPropertyPage

Specified by:

getPriority in interface IComPropertyPage2

Specified by:

getPriority in interface IPropertyPageContext

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object unkArray)
                throws IOException,
                       AutomationException

Check if property page applies to the specified set of objects. Signature corresponds to IPropertyPage::SetObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

applies in interface IPropertyPageContext

Parameters:

unkArray - A Variant (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createCompatibleObject

public Object createCompatibleObject(Object kind)
                              throws IOException,
                                     AutomationException

Create a new object using the specified object as a template. The kind argument may be NULL if the page interacts with only a single object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

createCompatibleObject in interface IPropertyPageContext

Parameters:

kind - A Variant (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryObject

public void queryObject(Object theObject)
                 throws IOException,
                        AutomationException

Apply the property page settings to the specified object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryObject in interface IPropertyPageContext

Parameters:

theObject - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile(int controlID)
                   throws IOException,
                          AutomationException

Returns the help file name for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHelpFile in interface IPropertyPageContext

Parameters:

controlID - The controlID (in)

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpId

public int getHelpId(int controlID)
              throws IOException,
                     AutomationException

Returns the help ID for the specified control.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHelpId in interface IPropertyPageContext

Parameters:

controlID - The controlID (in)

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws IOException,
                   AutomationException

Property sheet calls this when cancel button is pressed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

cancel in interface IComPropertyPage

Specified by:

cancel in interface IComPropertyPage2

Specified by:

cancel in interface IPropertyPageContext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String title)
              throws IOException,
                     AutomationException

The title of the property page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTitle in interface IComPropertyPage

Specified by:

setTitle in interface IComPropertyPage2

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

The title of the property page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTitle in interface IComPropertyPage

Specified by:

getTitle in interface IComPropertyPage2

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int priority)
                 throws IOException,
                        AutomationException

The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setPriority in interface IComPropertyPage

Specified by:

setPriority in interface IComPropertyPage2

Parameters:

priority - The priority (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public int getWidth()
             throws IOException,
                    AutomationException

The width of the page in pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getWidth in interface IComPropertyPage

Specified by:

getWidth in interface IComPropertyPage2

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public int getHeight()
              throws IOException,
                     AutomationException

The height of the page in pixels.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHeight in interface IComPropertyPage

Specified by:

getHeight in interface IComPropertyPage2

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPageSiteByRef

public void setPageSiteByRef(IComPropertyPageSite rhs1)
                      throws IOException,
                             AutomationException

The sheet that contains the page.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setPageSiteByRef in interface IComPropertyPage

Specified by:

setPageSiteByRef in interface IComPropertyPage2

Parameters:

rhs1 - A reference to a com.esri.arcgis.framework.IComPropertyPageSite (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IComPropertyPage2_isPageDirty

public boolean IComPropertyPage2_isPageDirty()
                                      throws IOException,
                                             AutomationException

Indicates if the page made any changes to the object(s).

Product Availability

Available with ArcGIS Desktop.

Specified by:

IComPropertyPage2_isPageDirty in interface IComPropertyPage2

Returns:

The isDirty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpFile

public String getHelpFile()
                   throws IOException,
                          AutomationException

The help file name for the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getHelpFile in interface IComPropertyPage

Specified by:

getHelpFile in interface IComPropertyPage2

Returns:

The helpFile

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHelpContextID

public int getHelpContextID(int controlID)
                     throws IOException,
                            AutomationException

The help context ID for the specified control on the page.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getHelpContextID in interface IComPropertyPage

Specified by:

getHelpContextID in interface IComPropertyPage2

Parameters:

controlID - The controlID (in)

Returns:

The helpID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activate

public int activate()
             throws IOException,
                    AutomationException

Occurs on page creation. Return the hWnd of the page here.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activate in interface IComPropertyPage

Specified by:

activate in interface IComPropertyPage2

Returns:

The hWnd (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(ISet objects)
                throws IOException,
                       AutomationException

Indicates if the page applies to the specified objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

applies in interface IComPropertyPage

Specified by:

applies in interface IComPropertyPage2

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

Returns:

The pApplies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjects

public void setObjects(ISet objects)
                throws IOException,
                       AutomationException

Supplies the page with the object(s) to be edited.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setObjects in interface IComPropertyPage

Specified by:

setObjects in interface IComPropertyPage2

Parameters:

objects - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws IOException,
                 AutomationException

Shows the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

show in interface IComPropertyPage

Specified by:

show in interface IComPropertyPage2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws IOException,
                 AutomationException

Hides the page.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hide in interface IComPropertyPage

Specified by:

hide in interface IComPropertyPage2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCancel

public boolean queryCancel()
                    throws IOException,
                           AutomationException

Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

queryCancel in interface IComPropertyPage2

Returns:

The queryCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IComPropertyPage_isPageDirty

public boolean IComPropertyPage_isPageDirty()
                                     throws IOException,
                                            AutomationException

Indicates if the page made any changes to the object(s).

Specified by:

IComPropertyPage_isPageDirty in interface IComPropertyPage

Returns:

The isDirty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.