Documentation

Class ChartLegendItem

This class represents a chart legend item.

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

Syntax

public class ChartLegendItem : Control, IInteractiveElement

Constructors

ChartLegendItem()

Declaration
public ChartLegendItem()

Fields

ItemStyleProperty

Identifies the ItemStyle dependency property.

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

LabelProperty

Identifies the Label dependency property.

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

MarkerFillProperty

Identifies the MarkerFill dependency property.

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

MarkerShapeProperty

Identifies the MarkerShape dependency property.

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

MarkerStrokeProperty

Identifies the MarkerStroke dependency property.

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

MarkerStrokeThicknessProperty

Identifies the MarkerStrokeThickness dependency property.

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

MaskVisibilityProperty

Identifies the MaskVisibility dependency property.

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

Properties

IsSelected

Gets or sets a value indicating whether this instance is clicked.

Declaration
protected bool IsSelected { get; set; }
Property Value
System.Boolean

True if this instance is clicked; otherwise, false.

ItemStyle

Gets or sets the style applied to the legend item marker.

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

Label

Gets or sets the text that appears in the legend item entry.

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

MarkerFill

Gets or sets the MarkerFill.

Declaration
public Brush MarkerFill { get; set; }
Property Value
System.Windows.Media.Brush

MarkerShape

Gets or sets the legend item marker shape.

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

MarkerStroke

Gets or sets the MarkerStroke.

Declaration
public Brush MarkerStroke { get; set; }
Property Value
System.Windows.Media.Brush

MarkerStrokeThickness

Gets or sets the stroke thickness of the legend item marker.

Declaration
public double MarkerStrokeThickness { get; set; }
Property Value
System.Double

MaskVisibility

Gets or sets a value indicating whether the built-in mask overlay should be visible or not.

Declaration
public Visibility MaskVisibility { get; set; }
Property Value
System.Windows.Visibility

The default value is Visible.
Remarks

This property is applicable only to a limited set of the supported themes (i.e. Office, Vista, Windows7). Also disabling the mask overlay will disable the item selection indicator as well.

Methods

ChartItemSelected(Boolean)

Called when the chart item is clicked.

Declaration
protected virtual void ChartItemSelected(bool value)
Parameters
System.Boolean value

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.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.

OnMouseEnter(MouseEventArgs)

Called before the System.Windows.UIElement.MouseEnter event occurs.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The data for the event.

OnMouseLeave(MouseEventArgs)

Called before the System.Windows.UIElement.MouseLeave event occurs.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The data for the event.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The data for the event.

Extension Methods