com.esri.arcgis.carto
Interface IMapServerLegendClasses

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerLegendClasses

public interface IMapServerLegendClasses
extends Serializable

Provides access to the Map Server Legend Classes Interface.

Product Availability

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

Method Summary

void	add(IMapServerLegendClass legendClass) Adds a legend class.
int	getCount() The legend class count.
IMapServerLegendClass	getElement(int index) The legend class at the specified position.
void	insert(int index, IMapServerLegendClass legendClass) Adds a legend class at the specified position.
void	remove(int index) Removes the legend class at the specified position.
void	removeAll() Removes all legend classes.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

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

IMapServerLegendClass getElement(int index)
                                 throws IOException,
                                        AutomationException

The legend class 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.IMapServerLegendClass

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 class 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 classes.

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(IMapServerLegendClass legendClass)
         throws IOException,
                AutomationException

Adds a legend class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

legendClass - A reference to a com.esri.arcgis.carto.IMapServerLegendClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerLegendClass legendClass)
            throws IOException,
                   AutomationException

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

legendClass - A reference to a com.esri.arcgis.carto.IMapServerLegendClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.