com.esri.arcgis.carto
Class IOleFrameProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IOleFrameProxy
All Implemented Interfaces:
IOleFrame, Externalizable, Serializable

public class IOleFrameProxy
extends com.esri.arcgis.interop.Dispatch
implements IOleFrame, Serializable

Provides access to the members that control the Graphic Element that holds an OLE object.

Remarks

While the interface IOleFrame is an ArcEngine level component, it is only implemented by OleFrame which is located in a non Engine library. Engine/Server applications will not be able to display the contents of the frame.

When To Use

IOleFrame is the default interface for the OleFrame object. The main purpose of the interface is to give the developer access to the OLE object stored within the frame. The developer can use this interface to display properties of the object, edit the object, or open it.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
com.esri.arcgis.carto.OleFrame, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IOleFrameProxy()
           
  IOleFrameProxy(Object obj)
           
protected IOleFrameProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void createOleClientItem(int oleDocument)
          Valid only in MFC environment.
 void edit()
          Edit the object in-place.
 boolean editProperties()
          Show the properties dialog for the object.
 void getOleClientItem()
          Valid only in MFC environment.
 void hide()
          Stop editing the object.
 void open()
          Edit the object in a separate application window.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
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, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IOleFrameProxy

public IOleFrameProxy()

IOleFrameProxy

public IOleFrameProxy(Object obj)
               throws IOException
Throws:
IOException

IOleFrameProxy

protected IOleFrameProxy(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

getOleClientItem

public void getOleClientItem()
                      throws IOException,
                             AutomationException
Valid only in MFC environment. Returns pointer to the COleClientItem representing the OLE object.

Remarks

OleClientItem is valid only in the MFC (Microsoft Foundation Classes) environment. The property can be used to return a pointer to the COleClientItem representing the OLE object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

createOleClientItem

public void createOleClientItem(int oleDocument)
                         throws IOException,
                                AutomationException
Valid only in MFC environment. Initialize the internal COleClientItem. Pass in a pointer to the application's COleDocument.

Remarks

OleClientItem is valid only in the MFC (Microsoft Foundation Classes) environment. The method is used to initialize the internal COleClientItem. Pass in a pointer to the application's COleDocument when executing the method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
createOleClientItem in interface IOleFrame
Parameters:
oleDocument - A COM void* (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public void open()
          throws IOException,
                 AutomationException
Edit the object in a separate application window.

Remarks

The Open method is used to open the OLE object in a separate window. Use this method when you want to open the OLE object in its native environment. For instance, if the OLE object is a Word document, executing the Open method will start Word with the current object as the active document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

edit

public void edit()
          throws IOException,
                 AutomationException
Edit the object in-place.

Remarks

The Edit method is used to edit the OLE object in place. Editing takes place with the frame defined for the object and no additional windows are created. In contrast, the Open method will open up a separate window for editing the object.

Use this method to provide editing capabilities for the OLE object without opening an additional window. Execute the Hide method to stop editing on the object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

hide

public void hide()
          throws IOException,
                 AutomationException
Stop editing the object.

Remarks

The Hide method is used to stop the editing process on the OLE object. The method should be executed after the Edit method has been utilized and the user has completed editing.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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

editProperties

public boolean editProperties()
                       throws IOException,
                              AutomationException
Show the properties dialog for the object.

Remarks

The EditProperties method is used to display the properties of the OLE object in a separate window. Use this method when you want the user to see the properties of the object in the frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
editProperties in interface IOleFrame
Returns:
The ok
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException