com.esri.arcgis.carto
Interface IFrameProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

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

public interface IFrameProperties
extends Serializable

Provides access to members that control the General properties for a frame.

Remarks

The IFrameProperties interface is used to modify the Background, Border, and Shadow of a frame element. See also IFrameDecoration.

Product Availability

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

Method Summary

IBorder	getBorder() Frame border used by this element.
IShadow	getShadow() Frame shadow used by this element.
IBackground	IFrameProperties_getBackground() Frame background used by this element.
void	setBackground(IBackground background) Frame background used by this element.
void	setBorder(IBorder border) Frame border used by this element.
void	setShadow(IShadow shadow) Frame shadow used by this element.

Method Detail

getBorder

IBorder getBorder()
                  throws IOException,
                         AutomationException

Frame border used by this element.

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.

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.

IFrameProperties_getBackground

IBackground IFrameProperties_getBackground()
                                           throws IOException,
                                                  AutomationException

Frame background used by this element.

Product Availability

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

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.

getShadow

IShadow getShadow()
                  throws IOException,
                         AutomationException

Frame shadow used by this element.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadow

void setShadow(IShadow shadow)
               throws IOException,
                      AutomationException

Frame shadow used by this element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

shadow - A reference to a com.esri.arcgis.carto.IShadow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.