com.esri.arcgis.framework
Interface IComPropertySheet

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ComPropertySheet, IComPropertySheetProxy

public interface IComPropertySheet
extends java.io.Serializable

COM Interface 'IComPropertySheet'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriFramework.olb'

Description: 'Provides access to members that work with a COM property sheet.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID76951cc7_dbb1_11d2_b868_00600802e603
static int	xxDummy Deprecated. Internal use only

Method Summary

void	addCategoryID(IUID category) Adds a new Category ID used to look up COM property pages.
void	addPage(java.lang.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.
java.lang.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(java.lang.String title) The title of the property sheet.

Field Detail

IID76951cc7_dbb1_11d2_b868_00600802e603

static final int IID76951cc7_dbb1_11d2_b868_00600802e603

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setTitle

void setTitle(java.lang.String title)
              throws java.io.IOException,
                     AutomationException

The title of the property sheet.

Parameters:

title - The title (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

java.lang.String getTitle()
                          throws java.io.IOException,
                                 AutomationException

The title of the property sheet.

Returns:

The title

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActivePage

void setActivePage(short index)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

index - The index (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivePage

short getActivePage()
                    throws java.io.IOException,
                           AutomationException

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

Returns:

The index

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisableCancelButton

void setDisableCancelButton(boolean disableButton)
                            throws java.io.IOException,
                                   AutomationException

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

Parameters:

disableButton - The disableButton (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisableCancelButton

boolean isDisableCancelButton()
                              throws java.io.IOException,
                                     AutomationException

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

Returns:

The disableButton

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideApplyButton

void setHideApplyButton(boolean hideApplyButton)
                        throws java.io.IOException,
                               AutomationException

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

Parameters:

hideApplyButton - The hideApplyButton (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideApplyButton

boolean isHideApplyButton()
                          throws java.io.IOException,
                                 AutomationException

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

Returns:

The hideApplyButton

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideHelpButton

void setHideHelpButton(boolean hideHelpButton)
                       throws java.io.IOException,
                              AutomationException

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

Parameters:

hideHelpButton - The hideHelpButton (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideHelpButton

boolean isHideHelpButton()
                         throws java.io.IOException,
                                AutomationException

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

Returns:

The hideHelpButton

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addCategoryID

void addCategoryID(IUID category)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearCategoryIDs

void clearCategoryIDs()
                      throws java.io.IOException,
                             AutomationException

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPage

void addPage(java.lang.Object page)
             throws java.io.IOException,
                    AutomationException

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

Parameters:

page - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canEdit

boolean canEdit(ISet objects)
                throws java.io.IOException,
                       AutomationException

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

Parameters:

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

Returns:

The result

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

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

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

Parameters:

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

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

Returns:

The ok

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.