com.esri.arcgis.framework
Class IComPropertyPage2Proxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.framework.IComPropertyPage2Proxy
All Implemented Interfaces:
IComPropertyPage2, Externalizable, Serializable

public class IComPropertyPage2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IComPropertyPage2, Serializable

Provides access to members that control a COM property page.

Product Availability

Available with ArcGIS Desktop.

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IComPropertyPage2Proxy()
           
  IComPropertyPage2Proxy(Object obj)
           
protected IComPropertyPage2Proxy(Object obj, String iid)
           
 
Method Summary
 int activate()
          Occurs on page creation.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 IComPropertyPage2_isPageDirty()
          Indicates if the page made any changes to the object(s).
 boolean queryCancel()
          Returns VARIANT_FALSE to prevent the cancel operation or VARIANT_TRUE to allow it.
 void removeListener(String iidStr, Object theListener)
           
 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.
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

IComPropertyPage2Proxy

public IComPropertyPage2Proxy()

IComPropertyPage2Proxy

public IComPropertyPage2Proxy(Object obj)
                       throws IOException
Throws:
IOException

IComPropertyPage2Proxy

protected IComPropertyPage2Proxy(Object obj,
                                 String iid)
                          throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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 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 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 IComPropertyPage2
Parameters:
priority - The priority (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 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:
getPriority in interface IComPropertyPage2
Returns:
The priority
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 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 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 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 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 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 IComPropertyPage2
Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deactivate

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
deactivate in interface IComPropertyPage2
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 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 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 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 IComPropertyPage2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
apply in interface IComPropertyPage2
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cancel

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

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
cancel 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.