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

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

IMapServer3.GetLegendInfo Method

Returns a collection of Map Server Legend Info objects for the specified layers. If layerIDs is Nothing/Null or empty, legend information for all layers is returned.

[Visual Basic .NET]
Public Function GetLegendInfo ( _
    ByVal MapName As String, _
    ByVal layerIds As ILongArray, _
    ByVal patch As IMapServerLegendPatch, _
    ByVal imgType As IImageType _
) As IMapServerLegendInfos
public IMapServerLegendInfos GetLegendInfo (
    string MapName,
    ILongArray layerIds,
    IMapServerLegendPatch patch,
    IImageType imgType
HRESULT GetLegendInfo(
  BSTR MapName,
  ILongArray* layerIds,
  IMapServerLegendPatch* patch,
  IImageType* imgType
MapName [in]

MapName is a parameter of type BSTR layerIds [in]
layerIds is a parameter of type ILongArray* patch [in]
patch is a parameter of type IMapServerLegendPatch* imgType [in]
imgType is a parameter of type IImageType*

Product Availability

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


Use GetLegendInfo to retrieve individual legend elements including the symbol image, labels, descriptions and headings. A common use would be to populate a table of contents. Note that composite layers such as group layers and annotation layers do not contain legend elements. To export a single image of the legend use ExportLegend on IMapServerLayout.

The GetLegendInfo method returns a collection of MapServerLegendInfo objects. 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. Customizing the legend patch can be done using IMapServerLegendPatch . When passing in "Nothing" for this input parameter ("patch") the default legend patch is used.

MapServerLegendInfo doesn't contain information about whether the data frame and the layers in the TOC are expanded or collapsed in the original map document. You have to write your own code to find this out.

See Also

IMapServer3 Interface