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


ILegendClassFormat Interface (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IL > ILegendClassFormat Interface (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (Carto)  

ILegendClassFormat Interface

Provides access to members that control formatting information for a legend class.

Product Availability

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

Members

Description
Read/write property AreaPatch The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat).
Read/write property DescriptionSymbol Text symbol used to draw legend group descriptions.
Read/write property LabelSymbol Text symbol used to draw the legend group labels.
Read/write property LinePatch The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat).
Read/write property PatchHeight Height of the patch in points.
Read/write property PatchWidth Width of the patch in points.

CoClasses that implement ILegendClassFormat

CoClasses and Classes Description
LegendClassFormat Formatting information for the legend/TOC entry of a renderer class.

Remarks

The LegendClassFormat defines the aspect of a LegendItem. Each LegendItem has its own LegendClassFormat which not surprisingly can be accessed through ILegendItem::LegendClassFormat.

A legend item may consist of a patch, a label and an optional description:

An area patch will be used for a layer displaying polygons and a line patch for a layer displaying lines.

A number of properties are provided to manage the patches used for this legend item. For more on patches, see the help under IPatch.

LabelSymbol and DescriptionSymbol allow you to set the TextSymbol used to display the Label and Description.