This document is archived and information here might be outdated.  Recommended version.

IMapServerLegendClass Interface (ArcObjects .NET 10.8 SDK)
ArcObjects Help for .NET developers > ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMapServerLegendClass Interface
ArcGIS Developer Help

IMapServerLegendClass Interface

Provides access to the Map Server Legend Class Interface.

Product Availability

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

When To Use

Use IMapServerLegendClass when retrieving legend elements including the symbol image, label and description of a single legend class. To export a single image of the legend use ExportLegend on IMapServerLayout.


Name Description
Read-only property Description The description string.
Read-only property Label The label string.
Read-only property SymbolImage The symbol image.
Read-only property TransparentColor The transparent color used for the symbol image.

Classes that implement IMapServerLegendClass

Classes Description
MapServerLegendClass The Map Server Legend Class coclass contains settings about a legend class.


Legends are associated with renderers that belong to each layer in a map. Each layer has a separate renderer. Each renderer has one or more legend groups. Each legend group has one or more legend classes. MapServerLegendClass objects are part of a MapServerLegendGroup object. MapServerLegendGroup objects are part of a MapServerLegendInfo object. MapServerLegendInfo objects are the result of the GetLegendInfo  method on IMapServer .