ClassHeatMapLegendElement
Definition
Namespace:Telerik.WinControls.UI.HeatMap
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class HeatMapLegendElement : StackLayoutElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProviderInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementStackLayoutElementHeatMapLegendElement
Implements:
Inherited Members
Constructors
HeatMapLegendElement(RadHeatMapElement)
Initializes a new instance of the HeatMapLegendElement class.
Declaration
public HeatMapLegendElement(RadHeatMapElement heatMapElement)Parameters
heatMapElement
The HeatMap element.
Properties
AutoGenerateItems
Gets or sets a value indicating whether to generate legend items automatically. If true the legend items are automatically created when ShowLegend is set to true. The VisualItemCreating is fired for each created item. If false, the legend items are not created and the developer adds them programmatically.
LegendTitle
Gets or sets the legend title text.
PanelElement
Gets the panel element used for organizing the legend items.
Declaration
public WrapLayoutPanel PanelElement { 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
ValueFormat
Gets or sets the format for numeric values.
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 panel element.
Declaration
protected virtual WrapLayoutPanel CreateStackElement()Returns
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.
OnVisualItemCreating(LegendItemElementCreatingEventArgs)
Called when [visual item creating].
Declaration
protected virtual void OnVisualItemCreating(LegendItemElementCreatingEventArgs e)Parameters
e
LegendItemElementCreatingEventArgs
The event arguments.
ResetVisualItems()
Declaration
protected virtual void ResetVisualItems()Events
VisualItemCreating
Occurs when a legend visual item is being created. Suitable to modify the item or replace it with a new one.
Declaration
public event LegendItemElementCreatingEventHandler VisualItemCreatingEvent Value