com.esri.arcgis.carto
Interface IMapImages

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapImages

public interface IMapImages
extends Serializable

Provides access to the Map Images Interface.

Product Availability

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

Method Summary

void	add(IMapImage mapImg) Adds a map image.
int	getCount() The map image count.
IMapImage	getElement(int index) The map image at the specified position.
void	insert(int index, IMapImage mapImg) Adds a map image at the specified position.
void	remove(int index) Removes the map image at the specified position.
void	removeAll() Removes all map images.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The map image 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

IMapImage getElement(int index)
                     throws IOException,
                            AutomationException

The map image 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.IMapImage

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 image 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 images.

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(IMapImage mapImg)
         throws IOException,
                AutomationException

Adds a map image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

mapImg - A reference to a com.esri.arcgis.carto.IMapImage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapImage mapImg)
            throws IOException,
                   AutomationException

Adds a map image 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)

mapImg - A reference to a com.esri.arcgis.carto.IMapImage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.