com.esri.arcgis.carto
Interface IOleFrame

All Superinterfaces:

Serializable

All Known Implementing Classes:

IOleFrameProxy, OleFrame

public interface IOleFrame
extends 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.

See Also:

com.esri.arcgis.carto.OleFrame

Method Summary

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.

Method Detail

getOleClientItem

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createOleClientItem

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

Parameters:

oleDocument - A COM void* (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

edit

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editProperties

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

Returns:

The ok

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.