com.esri.arcgis.framework
Interface IComPropertyPage

All Superinterfaces:
Serializable
All Known Implementing Classes:
BaseCustomLayerPropertyPage, BaseCustomRendererPropertyPage, BasePropertyPage, BaseSOEPropertyPage, IComPropertyPageProxy

public interface IComPropertyPage
extends Serializable

COM Interface 'IComPropertyPage'. Generated 5/30/2008 3:19:02 PM from 'C:\ArcGIS\com\esriFramework.olb'

Generated using ArcGIS Proxy Generator

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


Field Summary
static String IID
          Deprecated. Internal use only
static int IID76951cc6_dbb1_11d2_b868_00600802e603
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int activate()
          Occurs on page creation.
 boolean applies(ISet objects)
          Indicates if the page applies to the specified objects.
 void apply()
          Applies any changes to the object(s).
 void cancel()
          Cancels the changes to the object(s).
 void deactivate()
          Destroys the page.
 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.
 int getPriority()
          The page priority.
 String getTitle()
          The title of the property page.
 int getWidth()
          The width of the page in pixels.
 void hide()
          Hides the page.
 boolean isPageDirty()
          Indicates if the page made any changes to the object(s).
 void setObjects(ISet objects)
          Supplies the page with the object(s) to be edited.
 void setPageSiteByRef(IComPropertyPageSite rhs1)
          The sheet that contains the page.
 void setPriority(int priority)
          The page priority.
 void setTitle(String title)
          The title of the property page.
 void show()
          Shows the page.
 

Field Detail

IID76951cc6_dbb1_11d2_b868_00600802e603

static final int IID76951cc6_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 String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setTitle

void setTitle(String title)
              throws IOException,
                     AutomationException
The title of the property page.

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 page.

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

setPriority

void setPriority(int priority)
                 throws IOException,
                        AutomationException
The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

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

getPriority

int getPriority()
                throws IOException,
                       AutomationException
The page priority. The higher the priority, the sooner the page appears in the containing property sheet.

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

getWidth

int getWidth()
             throws IOException,
                    AutomationException
The width of the page in pixels.

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

getHeight

int getHeight()
              throws IOException,
                     AutomationException
The height of the page in pixels.

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

setPageSiteByRef

void setPageSiteByRef(IComPropertyPageSite rhs1)
                      throws IOException,
                             AutomationException
The sheet that contains the page.

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.

isPageDirty

boolean isPageDirty()
                    throws IOException,
                           AutomationException
Indicates if the page made any changes to the object(s).

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

getHelpFile

String getHelpFile()
                   throws IOException,
                          AutomationException
The help file name for the page.

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

getHelpContextID

int getHelpContextID(int controlID)
                     throws IOException,
                            AutomationException
The help context ID for the specified control on the page.

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

activate

int activate()
             throws IOException,
                    AutomationException
Occurs on page creation. Return the hWnd of the page here.

Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

void deactivate()
                throws IOException,
                       AutomationException
Destroys the page.

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

applies

boolean applies(ISet objects)
                throws IOException,
                       AutomationException
Indicates if the page applies to the specified objects.

Parameters:
objects - A reference to a (in)
Returns:
The pApplies
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjects

void setObjects(ISet objects)
                throws IOException,
                       AutomationException
Supplies the page with the object(s) to be edited.

Parameters:
objects - A reference to a (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

show

void show()
          throws IOException,
                 AutomationException
Shows the page.

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

hide

void hide()
          throws IOException,
                 AutomationException
Hides the page.

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

apply

void apply()
           throws IOException,
                  AutomationException
Applies any changes to the object(s).

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

cancel

void cancel()
            throws IOException,
                   AutomationException
Cancels the changes to the object(s).

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