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


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

ILegendClass Interface

Provides access to members that control the legend/TOC entry for a renderer class.

Product Availability

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

Members

Name Description
Read/write property Description Legend class description.
Read/write property Format Optional. If non-null, then layer specifies class formatting information.
Read/write property Label Legend class label.
Read/write property Symbol Legend class symbol.

Classes that implement ILegendClass

Classes Description
LegendClass The legend/TOC entry for a single renderer class.
RepresentationLegendClass A legend class object identifying a representation rule.
TemporalLegendClass (esriTrackingAnalyst) Controls settings for individual temporal class, such as time window period and offset.

Remarks

There are typically many LegendClass objects in a LegendGroup. Each legend class contains a symbol and descriptive text strings form of a Label and Description. The Label appears in the table of contents, and the label and description can appear in the legend.

If a legend group is editable, then the symbol and label for the label classes contained by the legend group can be edited in the table of contents. Changes to symbols symbol will change the renderer's symbology and the map will refresh to reflect this change. Changes to labels will change the content of any legends that contain the layer.

The typically route for modifying renderer appeance through code is to go to the renderer objects themselves. For example, to change the simple renderer symbol, label and description fields, use the methods and properties of ISimpleRenderer in preference to the legend class object.