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


IMapServerLegendPatch Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IM > IMapServerLegendPatch Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IMapServerLegendPatch Interface

Provides access to the Map Server Legend Patch Interface.

Product Availability

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

When To Use

A MapServerLegendPatch object is a parameter of the GetLegendInfo method on IMapServer. Use IMapServerLegendPatch to customize the size of the legend patch and the shape of the symbol displayed on the patch. To export a single image of the legend use ExportLegend on IMapServerLayout.

Members

Description
Read/write property AreaPatch The area patch.
Read/write property LinePatch The line patch.
Read/write property PatchHeight The patch height (in points).
Read/write property PatchResolution The patch resolution (dots per inch).
Read/write property PatchWidth The patch width (in points).

CoClasses that implement IMapServerLegendPatch

CoClasses and Classes Description
MapServerLegendPatch The Map Server Legend Patch coclass contains settings about a legend patch.

Remarks

A legend patch is a rectangular image with an individual polygon, line or point symbol associated with a particular legend class. Use PatchHeight and PatchWidth to change the size of the legend patch. Use AreaPatch or LinePatch to change the shape of the symbol. If the goal is only to change the size of the patch and to retain the default shape, AreaPatch and LinePatch do not have to be set.