com.esri.arcgis.carto
Interface ILegendGroups

All Superinterfaces:

Serializable

All Known Implementing Classes:

LegendGroups

public interface ILegendGroups
extends Serializable

Provides access to the Legend Groups Interface.

Product Availability

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

Method Summary

void	add(ILegendGroup legendGroup) Add a legend group.
int	getCount() The legend group count.
ILegendGroup	getElement(int index) Legend group at the specified position.
void	insert(int index, ILegendGroup legendGroup) Add a legend group at the specified posiiton.
void	remove(int index) Legend group at the specified position.
void	removeAll() Remove 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

ILegendGroup getElement(int index)
                        throws IOException,
                               AutomationException

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.ILegendGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

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

Remove 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(ILegendGroup legendGroup)
         throws IOException,
                AutomationException

Add a legend group.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

legendGroup - A reference to a com.esri.arcgis.carto.ILegendGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            ILegendGroup legendGroup)
            throws IOException,
                   AutomationException

Add a legend group at the specified posiiton.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

legendGroup - A reference to a com.esri.arcgis.carto.ILegendGroup (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.