Class Legend

The Legend control is used to display symbology and description for a set of s in a or contained in a GeoView.

Inheritance
Object
Legend
Namespace: Esri.ArcGISRuntime.Toolkit.UI.Controls
Assembly: Esri.ArcGISRuntime.Toolkit.WinUI.dll
Syntax
public class Legend : Control

Constructors

| Improve this Doc View Source

Legend()

Initializes a new instance of the Legend class.

Declaration
public Legend()

Fields

| Improve this Doc View Source

FilterByVisibleScaleRangeProperty

Identifies the FilterByVisibleScaleRange dependency property.

Declaration
public static readonly DependencyProperty FilterByVisibleScaleRangeProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

FilterHiddenLayersProperty

Identifies the FilterHiddenLayers dependency property.

Declaration
public static readonly DependencyProperty FilterHiddenLayersProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

GeoViewProperty

Identifies the GeoView dependency property.

Declaration
public static readonly DependencyProperty GeoViewProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ItemTemplateSelectorProperty

Identifies the ItemTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty ItemTemplateSelectorProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

LayerItemTemplateProperty

Identifies the LayerItemTemplate dependency property.

Declaration
public static readonly DependencyProperty LayerItemTemplateProperty
Field Value
Type Description
DependencyProperty
Remarks

If this is set to null, the SublayerItemTemplate will be used instead.

| Improve this Doc View Source

LegendInfoItemTemplateProperty

Identifies the LegendInfoItemTemplate dependency property.

Declaration
public static readonly DependencyProperty LegendInfoItemTemplateProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

ReverseLayerOrderProperty

Identifies the ReverseLayerOrder dependency property.

Declaration
public static readonly DependencyProperty ReverseLayerOrderProperty
Field Value
Type Description
DependencyProperty
| Improve this Doc View Source

SublayerItemTemplateProperty

Identifies the SublayerItemTemplate dependency property.

Declaration
public static readonly DependencyProperty SublayerItemTemplateProperty
Field Value
Type Description
DependencyProperty

Properties

| Improve this Doc View Source

FilterByVisibleScaleRange

Gets or sets a value indicating whether the scale of GeoView and any scale ranges on the s are used to determine when legend for layer is displayed.

Declaration
public bool FilterByVisibleScaleRange { get; set; }
Property Value
Type Description
Boolean

If true, legend for layer is displayed only when layer is in visible scale range; otherwise, false, legend for layer is displayed regardless of its scale range.
| Improve this Doc View Source

FilterHiddenLayers

Gets or sets a value indicating whether the visibility of a is used to determine when the legend for the layer is displayed.

Declaration
public bool FilterHiddenLayers { get; set; }
Property Value
Type Description
Boolean

If true, legend for the layer and sublayers is displayed only when the layer's property is true.
| Improve this Doc View Source

GeoView

Gets or sets the geoview that contain the layers whose symbology and description will be displayed.

Declaration
public GeoView? GeoView { get; set; }
Property Value
Type Description
Nullable<GeoView>
| Improve this Doc View Source

ItemTemplateSelector

Gets or sets the template selector used for selecting templates for each entry in the list.

Declaration
public DataTemplateSelector ItemTemplateSelector { get; set; }
Property Value
Type Description
DataTemplateSelector
Remarks

If the default template selector is overridden, the item templates will not apply.

| Improve this Doc View Source

LayerItemTemplate

Gets or sets the item template for each entry.

Declaration
public DataTemplate LayerItemTemplate { get; set; }
Property Value
Type Description
DataTemplate
Remarks

If this is set to null, the SublayerItemTemplate will be used instead.

See Also
| Improve this Doc View Source

LegendInfoItemTemplate

Gets or sets the item template for each content entry.

Declaration
public DataTemplate LegendInfoItemTemplate { get; set; }
Property Value
Type Description
DataTemplate
See Also
| Improve this Doc View Source

ReverseLayerOrder

Gets or sets a value indicating whether the order of layers in the GeoView are displayed top to bottom.

Declaration
public bool ReverseLayerOrder { get; set; }
Property Value
Type Description
Boolean

If true, legend for layers is displayed from top to bottom order; otherwise, false, legend for layers is displayed from bottom to top order.
| Improve this Doc View Source

SublayerItemTemplate

Gets or sets the item template for each entry that is not a .

Declaration
public DataTemplate SublayerItemTemplate { get; set; }
Property Value
Type Description
DataTemplate
See Also

Methods

| Improve this Doc View Source

OnApplyTemplate()

Declaration
protected override void OnApplyTemplate()