ESRI.ArcGIS.ADF.Web.UI.WebControls
RenderLegendHtml Method
See Also 
ESRI.ArcGIS.ADF.Web.UI.WebControls Namespace > Toc Class : RenderLegendHtml Method




map
Map control that determines map resources and layers.
hiddenResources
List of map resources to hide from the legend.
separator
String used as a separator between subelements of a resource/layer serialization.
condensed
Whether to render legend in condensed mode.
columns
How many columns to use for rendering the legend.
columnThreshold
The number of swatch elements that must appear when the layer swatches span multiple columns.
legendFontSize
The size in pixels of the font to use when rendering the legend text.
legendPageSize
The size in inches of the width of the page to be used when rendering the legend.
Generate HTML for TOC as a legend. All enabled child nodes will be expanded so the swatches will appear along with textual representation.

Syntax

Visual Basic (Declaration) 
Public Shared Function RenderLegendHtml( _
   ByVal map As Map, _
   ByVal hiddenResources As List(Of String), _
   ByVal separator As String, _
   ByVal condensed As Boolean, _
   ByVal columns As Integer, _
   ByVal columnThreshold As Integer, _
   ByVal legendFontSize As Integer, _
   ByVal legendPageSize As Double _
) As String
Visual Basic (Usage)Copy Code
Dim map As Map
Dim hiddenResources As List(Of String)
Dim separator As String
Dim condensed As Boolean
Dim columns As Integer
Dim columnThreshold As Integer
Dim legendFontSize As Integer
Dim legendPageSize As Double
Dim value As String
 
value = Toc.RenderLegendHtml(map, hiddenResources, separator, condensed, columns, columnThreshold, legendFontSize, legendPageSize)
C# 
public static string RenderLegendHtml( 
   Map map,
   List<string> hiddenResources,
   string separator,
   bool condensed,
   int columns,
   int columnThreshold,
   int legendFontSize,
   double legendPageSize
)

Parameters

map
Map control that determines map resources and layers.
hiddenResources
List of map resources to hide from the legend.
separator
String used as a separator between subelements of a resource/layer serialization.
condensed
Whether to render legend in condensed mode.
columns
How many columns to use for rendering the legend.
columnThreshold
The number of swatch elements that must appear when the layer swatches span multiple columns.
legendFontSize
The size in pixels of the font to use when rendering the legend text.
legendPageSize
The size in inches of the width of the page to be used when rendering the legend.

Return Value

HTML string representing TOC as a legend.

See Also

© 2010 All Rights Reserved.