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

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

ILegend Interface

Provides access to members that control a legend. Note: the ILegend interface has been superseded by ILegend2. Please consider using the more recent version.

Product Availability

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


Name Description
Method AddItem Adds a new item to the legend (to the end of the list).
Read/write property AutoAdd Indicates if a new item should be added when a new layer is added to the map.
Read/write property AutoReorder Indicates if the legend items should be kept in the same order as the layers.
Read/write property AutoVisibility Indicates if items should be shown only when associated layers are visible.
Method ClearItems Removes all items from the legend.
Method DelayEvents Used to batch operations together to minimize notifications.
Method Draw Draws the map surround into the specified display bounds.
Method FitToBounds Adjusts the map surround to fit the bounds. The changed argument indicates whether the size of the map surround was changed.
Read/write property FlowRight Reserved for future use.
Read/write property Format The formatting options for the legend (can be stored in the style gallery).
Read-only property Icon Icon used to represent the map surround.
Method InsertItem Inserts a new item into the legend (at the location specified by index).
Read-only property Item The specified item from the legend.
Read-only property ItemCount Number of items in the legend.
Read/write property Map The parent map.
Read/write property Name Name of the map surround.
Method QueryBounds Returns the bounds of the map surround.
Method Refresh Makes sure the latest updates are refected the next time the Map Surround is drawn.
Method RemoveItem Removes the specified item from the legend.
Read/write property Title Title.

Inherited Interfaces

Interfaces Description
IMapSurround Provides access to members that control the map surround.

Classes that implement ILegend

Classes Description
Legend A map surround for displaying a legend.


Use this interface to modify a legend and access its subparts.

A legend is mostly a collection of legend items, one for each layer of the map. See the ILegendItem documentation for information about these. ILegend provides access to and manages the legend’s items with the Item and ItemCount properties as well as the AddItem, InsertItem, RemoveItem and ClearItems methods.

The format of the legend is managed by the LegendFormat object. The Format properties gives access to this object through the ILegendFormat interface. ILegend also manages a few of the legend properties such as the Title . When changing the properties of an existing legend, you must call Refresh to have the changes reflected in the layout.

Finally the AutoAdd, AutoReorder and AutoVisibility properties are used to synchronize the aspect and ordering of the legend with the TOC. The default value for this property is True.

.NET Samples

Update a legend format with SymbologyControl area and line patches