ESRI.ArcGIS.ADF.Tasks
LegendSettings Property
See Also 
ESRI.ArcGIS.ADF.Tasks Namespace > PrintTask Class : LegendSettings Property




Settings for the Legend checkbox that allows the user to choose whether to include a legend in the printed page.

Syntax

Visual Basic (Declaration) 
<ResCategoryAttribute("PrintTask")>
<NotifyParentPropertyAttribute(True)>
<DesignerSerializationVisibilityAttribute()>
<ResDescriptionAttribute("Settings for the Legend.")>
Public Property LegendSettings As LegendItemSettings
Visual Basic (Usage)Copy Code
Dim instance As PrintTask
Dim value As LegendItemSettings
 
instance.LegendSettings = value
 
value = instance.LegendSettings
C# 
[ResCategoryAttribute("PrintTask")]
[NotifyParentPropertyAttribute(true)]
[DesignerSerializationVisibilityAttribute()]
[ResDescriptionAttribute("Settings for the Legend.")]
public LegendItemSettings LegendSettings {get; set;}

Remarks

A LegendItemSettings object stores properties that determine the inclusion of a legend in the printed page. The properties in a LegendItemSettings are:

  • DisplayInDialog: whether to display a check-box in the end-user Print task dialog. Whether this box is checked determines if the print page includes a legend. If this property is false(the default), then a legend is included depending on the value of DefaultValue.
  • DefaultValue: whether the legend will be included in the printed page. If DisplayInDialog is false, this value determines inclusion of the legend. If DisplayInDialog is true, the "Include Legend" check-box in the print dialog will initially be set based on this property. The default for DefaultValue is true (legend will be included).
  • Condensed: If true (the default), the legend shows only layer names and swatches with descriptions. If false, the legend will show all contents as displayed in the Toc, including map resource names and group layers, along with indented formatting.
  • HiddenLayers: a list (ResourceList) of names of layers to not include in the legend.

See Also

© 2010 All Rights Reserved.