ClassChartLegendElement
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.ChartView.dll
Syntax:
public class ChartLegendElement : StackLayoutElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementStackLayoutElementChartLegendElement
Implements:
Inherited Members
Constructors
ChartLegendElement(RadChartElement)
Initializes a new instance of the ChartLegendElement class.
Declaration
public ChartLegendElement(RadChartElement chartElement)
Parameters
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
ItemsLayout
Declaration
public LegendItemsLayout ItemsLayout { get; set; }
Property Value
ItemsOrientation
Gets or sets the orientation of the legend items. The possible values are Horizontal and Vertical.
Declaration
public Orientation ItemsOrientation { get; set; }
Property Value
LegendTitle
Gets or sets the legend title text.
Provider
Gets or sets the provider for the items that will be displayed.
Declaration
public ILegendInfoProvider Provider { get; set; }
Property Value
ScrollViewElement
Gets the scroll view element which hosts the stack element with legend items.
Declaration
public ScrollViewElement ScrollViewElement { get; }
Property Value
StackElement
Gets the stack element used for organizing the legend items.
Declaration
public StackLayoutElement StackElement { get; }
Property Value
TitleElement
Gets the title element.
Declaration
public LegendTitleElement TitleElement { get; }
Property Value
TitlePosition
Gets or sets the position of the legend title.
Declaration
public TitlePosition TitlePosition { get; set; }
Property Value
WrapPanelElement
Gets the wrap panel element used for organizing the legend items.
Declaration
public WrapLayoutPanel WrapPanelElement { get; }
Property Value
Methods
ArrangeOverride(SizeF)
Arranges the elements.
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
CreateScrollViewElement()
Creates the scroll view element.
Declaration
protected virtual ScrollViewElement CreateScrollViewElement()
Returns
CreateStackElement()
Creates the stack element.
Declaration
protected virtual StackLayoutElement CreateStackElement()
Returns
CreateWrapElement()
Creates the wrap panel element.
Declaration
protected virtual WrapLayoutPanel CreateWrapElement()
Returns
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
availableSize
The size that is available to the RadElement. The available size can be infinity (to take the full size of the element)
Returns
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, bool)
Raises the event.
Declaration
protected virtual void OnLegendInfosCollectionChanged(NotifyCollectionChangedEventArgs e, bool providerChange)
Parameters
e
NotifyCollectionChangedEventArgs
The NotifyCollectionChangedEventArgs instance containing the event data.
providerChange
The provider change.
OnVisualItemCreating(LegendItem)
Called when [visual item creating].
Declaration
protected virtual LegendItemElement OnVisualItemCreating(LegendItem item)
Parameters
item
The item.
Returns
Events
VisualItemCreating
Occurs when [visual item creating].
Declaration
public event LegendItemElementCreatingEventHandler VisualItemCreating
Event Value