com.esri.arcgis.framework
Interface IComPropertySheet

All Superinterfaces:

Serializable

All Known Implementing Classes:

ComPropertySheet

public interface IComPropertySheet
extends Serializable

Provides access to members that work with a COM property sheet.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addCategoryID(IUID category) Adds a new Category ID used to look up COM property pages.
void	addPage(Object page) Manually adds a page to the property sheet.
boolean	canEdit(ISet objects) Indicates if this object can edit the given set of objects.
void	clearCategoryIDs() Clears the category IDs used to look up COM property pages.
boolean	editProperties(ISet objects, int hWnd) Displays a property sheet for the given set of objects and returns a flag indicating if the objects changed.
short	getActivePage() The zero-based index of the page that is active.
String	getTitle() The title of the property sheet.
boolean	isDisableCancelButton() Indicates if the Cancel button is disabled on the property sheet.
boolean	isHideApplyButton() Indicates if the Apply button is visible on the property sheet.
boolean	isHideHelpButton() Indicates if the Help button is visible on the property sheet.
void	setActivePage(short index) The zero-based index of the page that is active.
void	setDisableCancelButton(boolean disableButton) Indicates if the Cancel button is disabled on the property sheet.
void	setHideApplyButton(boolean hideApplyButton) Indicates if the Apply button is visible on the property sheet.
void	setHideHelpButton(boolean hideHelpButton) Indicates if the Help button is visible on the property sheet.
void	setTitle(String title) The title of the property sheet.

Method Detail

setTitle

void setTitle(String title)
              throws IOException,
                     AutomationException

The title of the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

String getTitle()
                throws IOException,
                       AutomationException

The title of the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActivePage

void setActivePage(short index)
                   throws IOException,
                          AutomationException

The zero-based index of the page that is active.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivePage

short getActivePage()
                    throws IOException,
                           AutomationException

The zero-based index of the page that is active.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisableCancelButton

void setDisableCancelButton(boolean disableButton)
                            throws IOException,
                                   AutomationException

Indicates if the Cancel button is disabled on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

disableButton - The disableButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisableCancelButton

boolean isDisableCancelButton()
                              throws IOException,
                                     AutomationException

Indicates if the Cancel button is disabled on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The disableButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideApplyButton

void setHideApplyButton(boolean hideApplyButton)
                        throws IOException,
                               AutomationException

Indicates if the Apply button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hideApplyButton - The hideApplyButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideApplyButton

boolean isHideApplyButton()
                          throws IOException,
                                 AutomationException

Indicates if the Apply button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hideApplyButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideHelpButton

void setHideHelpButton(boolean hideHelpButton)
                       throws IOException,
                              AutomationException

Indicates if the Help button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hideHelpButton - The hideHelpButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideHelpButton

boolean isHideHelpButton()
                         throws IOException,
                                AutomationException

Indicates if the Help button is visible on the property sheet.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hideHelpButton

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCategoryID

void addCategoryID(IUID category)
                   throws IOException,
                          AutomationException

Adds a new Category ID used to look up COM property pages.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

category - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearCategoryIDs

void clearCategoryIDs()
                      throws IOException,
                             AutomationException

Clears the category IDs used to look up COM property pages.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPage

void addPage(Object page)
             throws IOException,
                    AutomationException

Manually adds a page to the property sheet. Page must implement IComPropertyPage or IPropertyPage.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

page - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEdit

boolean canEdit(ISet objects)
                throws IOException,
                       AutomationException

Indicates if this object can edit the given set of objects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

boolean editProperties(ISet objects,
                       int hWnd)
                       throws IOException,
                              AutomationException

Displays a property sheet for the given set of objects and returns a flag indicating if the objects changed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

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

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.