 |
This document is archived and information here might be outdated. Recommended version. |
ILegendFormat Interface (ArcObjects .NET 10.5 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
| ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IL > ILegendFormat Interface (ArcObjects .NET 10.5 SDK) |
Provides access to members that control formatting information for a legend.
| Description | ||
|---|---|---|
 |
DefaultAreaPatch | Area patch. Can be overridden by the LegendItem. |
|
DefaultLinePatch | Line patch. Can be overridden by the LegendItem. |
|
DefaultPatchHeight | Patch height in points. Can be overridden by the LegendItem. |
|
DefaultPatchWidth | Patch width in points. Can be overridden by the LegendItem. |
|
GroupGap | Vertical distance in points between legend groups. |
|
HeadingGap | Vertical distance in points between a heading and the legend graphics that follow. |
|
HorizontalItemGap | Horizontal distance in points between legend item columns. Used for legends that have more than one column. |
|
HorizontalPatchGap | Horizontal distance in points between a patch and the legend graphics before and after. |
|
LayerNameGap | Vertical distance in points between layer names and the legend graphics that follow. |
 |
Scale | Multiply all distances, gaps, and size property values on this interface by the specified scale factors. |
|
ShowTitle | Indicates if title is visibile. |
|
TextGap | Horizontal distance in points between labels and descriptions. |
|
TitleGap | Vertical distance in points between title and first legend item. |
|
TitlePosition | Legend title position. |
|
TitleSymbol | Text symbol used to draw the legend title. |
|
VerticalItemGap | Vertical distance in points between legend items. |
|
VerticalPatchGap | Vertical distance in points between patches. |
| CoClasses and Classes | Description |
|---|---|
| LegendFormat | A legend format. |
ILegendFormat controls general legend formatting.
Legend class formatting from a LegendClassFormat object can override some properties set through this interface (DefaultPatchWidth, DefaultPathHeight, DefaultLinePatch, DefaultAreaPatch). The LegendClassFormat object comes from either the layer (ILegendClass.Format), or from the legend (ILegendItem.LegendClassFormat ).
For more on patches, see the help under IPatch.
The LegendFormat also manages the format of the legend's title. Set ShowTitle to False to hide the title. TitlePosition allows you to set on which side of the legend the title will be displayed.
The gap properties define the spacing between the different parts of the legend.
The Scale method is used to resize the legend.