com.esri.arcgis.carto
Interface IMapServerLegendGroups

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapServerLegendGroups

public interface IMapServerLegendGroups
extends Serializable

Provides access to the Map Server Legend Groups Interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(IMapServerLegendGroup group)
          Adds a legend group.
 int getCount()
          The legend group count.
 IMapServerLegendGroup getElement(int index)
          The legend group at the specified position.
 void insert(int index, IMapServerLegendGroup group)
          Adds a legend group at the specified position.
 void remove(int index)
          Removes the legend group at the specified position.
 void removeAll()
          Removes all legend groups.
 

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException
The legend group 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

IMapServerLegendGroup getElement(int index)
                                 throws IOException,
                                        AutomationException
The legend group 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.IMapServerLegendGroup
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 group 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 groups.

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(IMapServerLegendGroup group)
         throws IOException,
                AutomationException
Adds a legend group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
group - A reference to a com.esri.arcgis.carto.IMapServerLegendGroup (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IMapServerLegendGroup group)
            throws IOException,
                   AutomationException
Adds a legend group 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)
group - A reference to a com.esri.arcgis.carto.IMapServerLegendGroup (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.