Class ChartLegend

This class represents the chart legend.

Inheritance
System.Object
ChartLegend
Namespace: Telerik.Windows.Controls.Charting
Assembly: Telerik.Windows.Controls.Charting.dll

Syntax

public class ChartLegend : HeaderedItemsControl, IChartThemable, IInteractionManager, IInteractiveElement, ILogicalItem

Constructors

ChartLegend()

Initializes a new instance of the ChartLegend class.

Declaration
public ChartLegend()

Fields

HeaderFontWeightProperty

Identifies the HeaderFontWeight dependency property.

Declaration
public static readonly DependencyProperty HeaderFontWeightProperty
Field Value
System.Windows.DependencyProperty

ItemsPanelOrientationProperty

Identifies the ItemsPanelOrientation dependency property.

Declaration
public static readonly DependencyProperty ItemsPanelOrientationProperty
Field Value
System.Windows.DependencyProperty

LegendItemMarkerShapeProperty

Identifies the LegendItemMarkerShape dependency property.

Declaration
public static readonly DependencyProperty LegendItemMarkerShapeProperty
Field Value
System.Windows.DependencyProperty

LegendItemStyleProperty

Identifies the LegendItemStyle dependency property.

Declaration
public static readonly DependencyProperty LegendItemStyleProperty
Field Value
System.Windows.DependencyProperty

ReverseLegendItemsOrderProperty

Identifies the ReverseLegendItemsOrder dependency property.

Declaration
public static readonly DependencyProperty ReverseLegendItemsOrderProperty
Field Value
System.Windows.DependencyProperty

UseAutoGeneratedItemsProperty

Identifies the UseAutoGeneratedItems dependency property.

Declaration
public static readonly DependencyProperty UseAutoGeneratedItemsProperty
Field Value
System.Windows.DependencyProperty

Properties

HeaderFontWeight

Gets or sets FontWeight for the HeaderTemplate of the ChartLegend.

Declaration
public FontWeight HeaderFontWeight { get; set; }
Property Value
System.Windows.FontWeight

The default value is bold.

Items

Gets or sets the custom (user-defined) legend items to display in the legend control.

Declaration
public ChartLegendItemCollection Items { get; set; }
Property Value
ChartLegendItemCollection

ItemsPanelOrientation

Gets or sets the items panel orientation.

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

The items panel orientation.

LegendItemMarkerShape

Gets or sets the legend item marker shape.

Declaration
public MarkerShape LegendItemMarkerShape { get; set; }
Property Value
MarkerShape

The legend item marker shape.

LegendItemStyle

Gets or sets the legend item style.

Declaration
public Style LegendItemStyle { get; set; }
Property Value
System.Windows.Style

The legend item style.

ReverseLegendItemsOrder

Gets or sets a value that indicates whether to reverse the order of ChartLegendItems.

Declaration
public bool ReverseLegendItemsOrder { get; set; }
Property Value
System.Boolean

UseAutoGeneratedItems

Gets or sets a value that indicates whether the legend should display auto-generated legend items or only custom (user-defined) items.

Declaration
public bool UseAutoGeneratedItems { get; set; }
Property Value
System.Boolean

The default value is true.

Methods

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.
System.Object item

Specified item.

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Extension Methods