Documentation

Class ChartLegendElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
StackLayoutElement
ChartLegendElement
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.ChartView.dll

Syntax

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

Constructors

ChartLegendElement(RadChartElement)

Initializes a new instance of the ChartLegendElement class.

Declaration
public ChartLegendElement(RadChartElement chartElement)
Parameters
RadChartElement chartElement

The chart element.

Properties

Items

Collection of LegendItem objects that hold the information required for display in a legend.

Declaration
public LegendItemCollection Items { get; }
Property Value
LegendItemCollection

ItemsLayout

Gets or sets the legend items layout type. The possible values are Stack and Wrap.

Declaration
public LegendItemsLayout ItemsLayout { get; set; }
Property Value
LegendItemsLayout

ItemsOrientation

Gets or sets the orientation of the legend items. The possible values are System.Windows.Forms.Orientation.Horizontal and System.Windows.Forms.Orientation.Vertical.

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

LegendTitle

Gets or sets the legend title text.

Declaration
public string LegendTitle { get; set; }
Property Value
System.String

Provider

Gets or sets the provider for the items that will be displayed.

Declaration
public ILegendInfoProvider Provider { get; set; }
Property Value
ILegendInfoProvider

ScrollViewElement

Gets the scroll view element which hosts the stack element with legend items.

Declaration
public ScrollViewElement ScrollViewElement { get; }
Property Value
ScrollViewElement

StackElement

Gets the stack element used for organizing the legend items.

Declaration
public StackLayoutElement StackElement { get; }
Property Value
StackLayoutElement

TitleElement

Gets the title element.

Declaration
public LegendTitleElement TitleElement { get; }
Property Value
LegendTitleElement

TitlePosition

Gets or sets the position of the legend title.

Declaration
public TitlePosition TitlePosition { get; set; }
Property Value
TitlePosition

WrapPanelElement

Gets the wrap panel element used for organizing the legend items.

Declaration
public WrapLayoutPanel WrapPanelElement { get; }
Property Value
WrapLayoutPanel

Methods

ArrangeOverride(SizeF)

Arranges the elements.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

Overrides

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreateLegendTitleElement()

Creates the legend title element.

Declaration
protected virtual LegendTitleElement CreateLegendTitleElement()
Returns
LegendTitleElement

CreateScrollViewElement()

Creates the scroll view element.

Declaration
protected virtual ScrollViewElement CreateScrollViewElement()
Returns
ScrollViewElement

CreateStackElement()

Creates the stack element.

Declaration
protected virtual StackLayoutElement CreateStackElement()
Returns
StackLayoutElement

CreateWrapElement()

Creates the wrap panel element.

Declaration
protected virtual WrapLayoutPanel CreateWrapElement()
Returns
WrapLayoutPanel

DisposeManagedResources()

Disposes the managed resources.

Declaration
protected override void DisposeManagedResources()
Overrides

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Measures the space required by the RadElement Used by the layout system.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
System.Drawing.SizeF

The minimum size required by the element to be completely visible. Cannot be infinity.
Overrides
Remarks

In this method call to the Measure method of each child must be made.

OnLegendInfosCollectionChanged(NotifyCollectionChangedEventArgs, Boolean)

Raises the LegendInfosCollectionChanged event.

Declaration
protected virtual void OnLegendInfosCollectionChanged(NotifyCollectionChangedEventArgs e, bool providerChange)
Parameters
NotifyCollectionChangedEventArgs e

The NotifyCollectionChangedEventArgs instance containing the event data.
System.Boolean providerChange

The provider change.

OnVisualItemCreating(LegendItem)

Called when [visual item creating].

Declaration
protected virtual LegendItemElement OnVisualItemCreating(LegendItem item)
Parameters
LegendItem item

The item.
Returns
LegendItemElement

Events

VisualItemCreating

Occurs when [visual item creating].

Declaration
public event LegendItemElementCreatingEventHandler VisualItemCreating
Event Type
LegendItemElementCreatingEventHandler

Extension Methods