com.esri.arcgis.carto
Interface IFrameElement

All Superinterfaces:

Serializable

All Known Subinterfaces:

IMapFrame, IMapSurroundFrame

All Known Implementing Classes:

BmpPictureElement, EmfPictureElement, FrameElement, GifPictureElement, GroupElement, ImgPictureElement, Jp2PictureElement, JpgPictureElement, MapFrame, MapSurroundFrame, OleFrame, PictureElement, PngPictureElement, SidPictureElement, TifPictureElement

public interface IFrameElement
extends Serializable

Provides access to members that control the Frame element object.

Remarks

IFrameElement is a generic interface implemented by all frame objects (FrameElement, OleFrame, MapFrame, and MapSurroundFrame). Use this interface when you want to get to the properties of the frames associated with the objects.

Product Availability

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

Method Summary

IBackground	getBackground() Frame background used by this element.
IBorder	getBorder() Frame border used by this element.
Object	getObject() Object framed by this element.
int	getThumbnail() Small bitmap representation of this element.
boolean	isDraftMode() Indicates if this element is in draft mode, i.e., draws fast.
void	setBackground(IBackground background) Frame background used by this element.
void	setBorder(IBorder border) Frame border used by this element.
void	setDraftMode(boolean draftMode) Indicates if this element is in draft mode, i.e., draws fast.

Method Detail

getObject

Object getObject()
                 throws IOException,
                        AutomationException

Object framed by this element.

Remarks

Object returns the object contained within the frame. Once the object is returned, it is up to the developer to figure out what type of object it is. Use this property when you wish to perform an operation on the object within the frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBorder

IBorder getBorder()
                  throws IOException,
                         AutomationException

Frame border used by this element.

Remarks

Border returns or sets the border property of the frame. Use this property when you want to change how the border around the frame is displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.carto.IBorder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBorder

void setBorder(IBorder border)
               throws IOException,
                      AutomationException

Frame border used by this element.

Description

Use this to set or return the Border property of an object of type IFrameElement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

border - A reference to a com.esri.arcgis.carto.IBorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

IBackground getBackground()
                          throws IOException,
                                 AutomationException

Frame background used by this element.

Remarks

Background returns or sets the background displayed with the frame. Use this property when you want to change how the background is displayed, or you want to retrieve the current background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.carto.IBackground

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackground

void setBackground(IBackground background)
                   throws IOException,
                          AutomationException

Frame background used by this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

background - A reference to a com.esri.arcgis.carto.IBackground (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThumbnail

int getThumbnail()
                 throws IOException,
                        AutomationException

Small bitmap representation of this element.

Remarks

Thumbnail returns a small bitmap representation of the contents of the frame. Use this property when you want to obtain a bitmap of the frame for display in another control.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The bitmapHandle (A COM typedef)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDraftMode

boolean isDraftMode()
                    throws IOException,
                           AutomationException

Indicates if this element is in draft mode, i.e., draws fast.

Remarks

DraftMode set or returns a property that controls the speed and detail of the drawing of the frame. When DraftMode is set to TRUE, the contents of the frame will draw quicker but without as much detail. When the property is set to FALSE, the contents take longer to draw but include all the details.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The draftMode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDraftMode

void setDraftMode(boolean draftMode)
                  throws IOException,
                         AutomationException

Indicates if this element is in draft mode, i.e., draws fast.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

draftMode - The draftMode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.