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 | ||
---|---|---|
AreaPatch | The area patch. (Optional. If non-null, this overrides default area patch specified by ILegend.LegendFormat). | |
DescriptionSymbol | Text symbol used to draw legend group descriptions. | |
LabelSymbol | Text symbol used to draw the legend group labels. | |
LinePatch | The line patch. (Optional. If non-null, this overrides default line patch specified by ILegend.LegendFormat). | |
PatchHeight | Height of the patch in points. | |
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.