com.esri.arcgis.carto
Interface IMapFrameDescriptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapFrameDescriptions

public interface IMapFrameDescriptions
extends Serializable

Provides access to the Map Frame Descriptions Interface.

Product Availability

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

Method Summary

void	add(IMapFrameDescription mapFrameDesc) Adds a map frame description.
int	getCount() The map frame description count.
IMapFrameDescription	getElement(int index) The map frame description at the specified position.
void	insert(int index, IMapFrameDescription mapFrameDesc) Adds a map frame description at the specified position.
void	remove(int index) Removes the map frame description at the specified position.
void	removeAll() Removes all map frame descriptions.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The map frame description count.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IMapFrameDescription getElement(int index)
                                throws IOException,
                                       AutomationException

The map frame description at the specified position.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes the map frame description at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all map frame descriptions.

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.

add

void add(IMapFrameDescription mapFrameDesc)
         throws IOException,
                AutomationException

Adds a map frame description.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapFrameDesc - A reference to a com.esri.arcgis.carto.IMapFrameDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapFrameDescription mapFrameDesc)
            throws IOException,
                   AutomationException

Adds a map frame description at the specified position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

mapFrameDesc - A reference to a com.esri.arcgis.carto.IMapFrameDescription (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.