Documentation

Class MapLegendElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
MapLegendElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadMap.dll

Syntax

public class MapLegendElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

MapLegendElement()

Initializes a new instance of the MapLegendElement class.

Declaration
public MapLegendElement()

MapLegendElement(IMapLegendInfoProvider)

Initializes a new instance of the MapLegendElement class.

Declaration
public MapLegendElement(IMapLegendInfoProvider legendInfoProvider)
Parameters
IMapLegendInfoProvider legendInfoProvider

The legend information provider.

Fields

HorizontalOrientationItemSpacingProperty

Declaration
public static RadProperty HorizontalOrientationItemSpacingProperty
Field Value
RadProperty

OrientationProperty

Declaration
public static RadProperty OrientationProperty
Field Value
RadProperty

VerticalOrientationItemSpacingProperty

Declaration
public static RadProperty VerticalOrientationItemSpacingProperty
Field Value
RadProperty

Properties

Converter

Gets or sets the converter used for converting an item to the text that will be displayed for it.

Declaration
public TypeConverter Converter { get; set; }
Property Value
System.ComponentModel.TypeConverter

The converter.

HorizontalOrientationItemSpacing

Gets or sets the item spacing when the orientation of the legend is vertical.

Declaration
public int HorizontalOrientationItemSpacing { get; set; }
Property Value
System.Int32

The item spacing.

ItemStackElement

Gets the item stack element.

Declaration
public StackLayoutElement ItemStackElement { get; }
Property Value
StackLayoutElement

The item stack element.

LegendInfoProvider

Gets or sets the legend information provider.

Declaration
public IMapLegendInfoProvider LegendInfoProvider { get; set; }
Property Value
IMapLegendInfoProvider

The legend information provider.

Orientation

Gets or sets the orientation of the items in the legend.

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Forms.Orientation

The orientation.

StackElement

Gets the stack element.

Declaration
public StackLayoutElement StackElement { get; }
Property Value
StackLayoutElement

The stack element.

SubtitleElement

Gets the title element.

Declaration
public MapLegendSubtitleElement SubtitleElement { get; }
Property Value
MapLegendSubtitleElement

The title element.

TitleElement

Gets the title element.

Declaration
public MapLegendTitleElement TitleElement { get; }
Property Value
MapLegendTitleElement

The title element.

VerticalOrientationItemSpacing

Gets or sets the item spacing when the orientation of the legend is vertical.

Declaration
public int VerticalOrientationItemSpacing { get; set; }
Property Value
System.Int32

The item spacing.

Methods

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateItemsStackLayoutElement()

Creates a item stack layout element.

Declaration
protected virtual StackLayoutElement CreateItemsStackLayoutElement()
Returns
StackLayoutElement

StackLayoutElement.

CreateMapLegendItemElement(MapLegendInfoItem)

Creates a map legend item element base on the provided item.

Declaration
protected virtual MapLegendItemElement CreateMapLegendItemElement(MapLegendInfoItem item)
Parameters
MapLegendInfoItem item

The item.
Returns
MapLegendItemElement

MapLegendItemElement.

CreateStackLayoutElement()

Creates a stack layout element.

Declaration
protected virtual StackLayoutElement CreateStackLayoutElement()
Returns
StackLayoutElement

StackLayoutElement.

CreateSubtitleElement()

Creates a subtitle element.

Declaration
protected virtual MapLegendSubtitleElement CreateSubtitleElement()
Returns
MapLegendSubtitleElement

MapLegendTitleElement.

CreateTitleElement()

Creates a title element.

Declaration
protected virtual MapLegendTitleElement CreateTitleElement()
Returns
MapLegendTitleElement

MapLegendTitleElement.

GetDisplayText(MapLegendInfoItem)

Gets the display text for a given item.

Declaration
protected virtual string GetDisplayText(MapLegendInfoItem item)
Parameters
MapLegendInfoItem item

The item.
Returns
System.String

System.String.

Initialize()

Initializes the items in the legend based on the LegendInfoProvider.

Declaration
public virtual void Initialize()

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

Extension Methods