com.esri.arcgis.carto
Interface IMapServerLegendInfos

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerLegendInfos

public interface IMapServerLegendInfos
extends Serializable

Provides access to the Map Server Legend Infos Interface.

Product Availability

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

Method Summary

void	add(IMapServerLegendInfo info) Adds a legend info.
int	getCount() The legend info count.
IMapServerLegendInfo	getElement(int index) The legend info at the specified position.
void	insert(int index, IMapServerLegendInfo info) Adds a legend info at the specified position.
void	remove(int index) Removes the legend info at the specified position.
void	removeAll() Removes all legend infos.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The legend info 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

IMapServerLegendInfo getElement(int index)
                                throws IOException,
                                       AutomationException

The legend info 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.IMapServerLegendInfo

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 legend info 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 legend infos.

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(IMapServerLegendInfo info)
         throws IOException,
                AutomationException

Adds a legend info.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

info - A reference to a com.esri.arcgis.carto.IMapServerLegendInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerLegendInfo info)
            throws IOException,
                   AutomationException

Adds a legend info 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)

info - A reference to a com.esri.arcgis.carto.IMapServerLegendInfo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.