Class RadDataBar

A control that contains a bar, the length of which represents a value in correspondence to the set minimum, maximum and origin value.

Inheritance
System.Object
RadDataBarBase
RadDataBar
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

[TelerikToolboxCategory("Data Visualization")]
public sealed class RadDataBar : RadDataBarBase

Constructors

RadDataBar()

Initializes a new instance of the RadDataBar class.

Declaration
public RadDataBar()

Fields

AppliedBarBorderBrushProperty

Identifies the AppliedBarBorderBrush dependency property.

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

AppliedBarBrushProperty

Identifies the AppliedBarBrush dependency property.

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

AppliedLabelMarginProperty

Identifies the AppliedLabelMargin dependency property.

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

AppliedOutOfRangeRuleProperty

Identifies the AppliedOutOfRangeRule dependency property.

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

AppliedOutOfRangeTemplateProperty

Identifies the AppliedOutOfRangeTemplate dependency property.

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

BarLeftPercentProperty

Identifies the BarLeftPercent dependency property.

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

BarRightPercentProperty

Identifies the BarRightPercent dependency property.

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

LabelDistanceProperty

Identifies the LabelDistance dependency property.

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

LabelFormatProperty

Identifies the LabelFormat dependency property.

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

LabelPositionProperty

Identifies the LabelPosition dependency property.

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

LabelStyleProperty

Identifies the LabelStyle dependency property.

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

LabelTextProperty

Identifies the LabelText dependency property.

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

LabelVisibilityProperty

Identifies the LabelVisibility dependency property.

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

NegativeValueBorderBrushProperty

Identifies the NegativeValueBorderBrush dependency property.

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

NegativeValueBrushProperty

Identifies the NegativeValueBrush dependency property.

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

ShowOutOfRangeIndicatorsProperty

Identifies the ShowOutOfRangeIndicators dependency property.

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

ValueBorderBrushProperty

Identifies the ValueBorderBrush dependency property.

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

ValueBrushProperty

Identifies the ValueBrush dependency property.

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

ValueProperty

Identifies the Value dependency property.

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

Properties

AppliedBarBorderBrush

Gets the brush that is set to the Stroke property of the DataBarShape.

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

Remarks

This property is set internally. If the Value is greater than the OriginValue, the value of this property is the same as the value of the ValueBorderBrush property. If the Value is less than the OriginValue, the value of this property is the same as the value of the NegativeValueBrush property.

AppliedBarBrush

Gets the brush that is set to the Fill property of the DataBarShape.

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

Remarks

This property is set internally. If the Value is greater than the OriginValue, the value of this property is the same as the value of the ValueBrush property. If the Value is less than the OriginValue, the value of this property is the same as the value of the NegativeValueBrush property.

AppliedLabelMargin

Gets the AppliedLabelMargin. This is the margin for the text block that contains the formatted value string.

Declaration
public Thickness AppliedLabelMargin { get; }
Property Value
System.Windows.Thickness

Remarks

This property is internally set in correspondence to the position of the DataBarShape and the value of the LabelPosition property.

AppliedOutOfRangeRule

Gets the rule that is applied when the Value is out of range.

Declaration
public OutOfRangeRule AppliedOutOfRangeRule { get; }
Property Value
OutOfRangeRule

Remarks

This property is set internally depending on the value of the ShowOutOfRangeIndicators property. If the Value is greater than the Maximum, the value of this property is Right. If the Value is less than the Minimum, the value of this property is Left.

AppliedOutOfRangeTemplate

Gets the template that is applied when the Value is out of range.

Declaration
public DataTemplate AppliedOutOfRangeTemplate { get; }
Property Value
System.Windows.DataTemplate

Remarks

This property is set internally. If the Value is greater than the Maximum, the value of this property is the same as the value of the OverflowTemplate property. If the Value is less than the Minimum, the value of this property is the same as the value of the UnderflowTemplate property.

BarLeftPercent

Gets the left percent.

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

Remarks

This property is internally set and is intended to set the LeftPercent property of the DataBarShape so that the bar shape is properly drawn in correspondence to the minimum, maximum and origin value.

BarRightPercent

Gets the right percent.

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

Remarks

This property is internally set and is intended to set the RightPercent property of the DataBarShape so that the bar shape is properly drawn in correspondence to the minimum, maximum and origin value.

LabelDistance

Gets or sets the minimal distance between the label and the DataBarShape.

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

Remarks

If the LabelPosition is set to Left, this is the AppliedLabelMargin.Left. If the LabelPosition is set to Right, this is the AppliedLabelMargin.Right.

LabelFormat

Gets or sets the string used for formatting the numeric value.

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

LabelPosition

Gets or sets the position of the label - at the left hand side, right hand side or at the end of the DataBarShape.

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

LabelStyle

Gets or sets the style that is applied to the label.

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

LabelText

Gets the text of the label.

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

Remarks

This property is internally set. If you need to, you can use the LabelFormat property to format this text.

LabelVisibility

Gets or sets the Visibility of the label.

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

NegativeValueBorderBrush

Gets or sets the brush that is set to the Stroke property of the DataBarShape when the Value is less than the OriginValue.

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

NegativeValueBrush

Gets or sets the brush that is set to the Fill property of the DataBarShape when the Value is less than the OriginValue.

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

ShowOutOfRangeIndicators

Gets or sets the ShowOutOfRangeIndicators. When this property is true and the Value is greater than the Maximum, an arrow is drawn at the right hand side of the DataBarShape indicating that the Value is out of range. When this property is true and the Value is less than the Minimum, an arrow is drawn at the right hand side of the DataBarShape indicating that the Value is out of range. When this property is false, no arrow is drawn.

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

Value

Gets or sets the value.

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

ValueBorderBrush

Gets or sets the brush that is set to the Stroke property of the DataBarShape when the Value is greater than the OriginValue.

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

ValueBrush

Gets or sets the brush that is set to the Fill property of the DataBarShape when the Value is greater than the OriginValue.

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

Methods

OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Maximum has changed.

Declaration
protected override void OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.
Overrides

OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Minimum has changed.

Declaration
protected override void OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.
Overrides

OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)

Called when the OriginValue has changed.

Declaration
protected override void OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.
Overrides

UpdateOutOfRangeTemplates()

Checks if the Value is out of range, and if it is - applies the proper out of range template.

Declaration
protected override void UpdateOutOfRangeTemplates()
Overrides

Extension Methods