Back to all docs
API Reference / Telerik.Windows.Controls / RadDataBar
New to Telerik UI for WPF? Start a free 30-day trial

RadDataBar

Class

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

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

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

Inheritance: objectRadDataBarBaseRadDataBar

Inherited Members RadDataBarBase.MinimumPropertyRadDataBarBase.MaximumPropertyRadDataBarBase.OriginValuePropertyRadDataBarBase.BarHeightPercentPropertyRadDataBarBase.AxisStrokePropertyRadDataBarBase.AxisVisibilityPropertyRadDataBarBase.BarStylePropertyRadDataBarBase.BarBorderThicknessPropertyRadDataBarBase.AppliedAxisVisibilityPropertyRadDataBarBase.AxisStylePropertyRadDataBarBase.AppliedAxisMarginPropertyRadDataBarBase.UnderflowTemplatePropertyRadDataBarBase.OverflowTemplatePropertyRadDataBarBase.MinimumRadDataBarBase.MaximumRadDataBarBase.OriginValueRadDataBarBase.BarHeightPercentRadDataBarBase.AxisStrokeRadDataBarBase.AxisVisibilityRadDataBarBase.AppliedAxisVisibilityRadDataBarBase.AxisStyleRadDataBarBase.AppliedAxisMarginRadDataBarBase.BarStyleRadDataBarBase.BarBorderThicknessRadDataBarBase.UnderflowTemplateRadDataBarBase.OverflowTemplate...

Constructors

RadDataBar()

Initializes a new instance of the RadDataBar class.

C#
public RadDataBar()

Fields

AppliedBarBorderBrushProperty

DependencyProperty

Identifies the AppliedBarBorderBrush dependency property.

C#
public static readonly DependencyProperty AppliedBarBorderBrushProperty

AppliedBarBrushProperty

DependencyProperty

Identifies the AppliedBarBrush dependency property.

C#
public static readonly DependencyProperty AppliedBarBrushProperty

AppliedLabelMarginProperty

DependencyProperty

Identifies the AppliedLabelMargin dependency property.

C#
public static readonly DependencyProperty AppliedLabelMarginProperty

AppliedOutOfRangeRuleProperty

DependencyProperty

Identifies the AppliedOutOfRangeRule dependency property.

C#
public static readonly DependencyProperty AppliedOutOfRangeRuleProperty

AppliedOutOfRangeTemplateProperty

DependencyProperty

Identifies the AppliedOutOfRangeTemplate dependency property.

C#
public static readonly DependencyProperty AppliedOutOfRangeTemplateProperty

BarLeftPercentProperty

DependencyProperty

Identifies the BarLeftPercent dependency property.

C#
public static readonly DependencyProperty BarLeftPercentProperty

BarRightPercentProperty

DependencyProperty

Identifies the BarRightPercent dependency property.

C#
public static readonly DependencyProperty BarRightPercentProperty

LabelDistanceProperty

DependencyProperty

Identifies the LabelDistance dependency property.

C#
public static readonly DependencyProperty LabelDistanceProperty

LabelFormatProperty

DependencyProperty

Identifies the LabelFormat dependency property.

C#
public static readonly DependencyProperty LabelFormatProperty

LabelPositionProperty

DependencyProperty

Identifies the LabelPosition dependency property.

C#
public static readonly DependencyProperty LabelPositionProperty

LabelStyleProperty

DependencyProperty

Identifies the LabelStyle dependency property.

C#
public static readonly DependencyProperty LabelStyleProperty

LabelTextProperty

DependencyProperty

Identifies the LabelText dependency property.

C#
public static readonly DependencyProperty LabelTextProperty

LabelVisibilityProperty

DependencyProperty

Identifies the LabelVisibility dependency property.

C#
public static readonly DependencyProperty LabelVisibilityProperty

NegativeValueBorderBrushProperty

DependencyProperty

Identifies the NegativeValueBorderBrush dependency property.

C#
public static readonly DependencyProperty NegativeValueBorderBrushProperty

NegativeValueBrushProperty

DependencyProperty

Identifies the NegativeValueBrush dependency property.

C#
public static readonly DependencyProperty NegativeValueBrushProperty

ShowOutOfRangeIndicatorsProperty

DependencyProperty

Identifies the ShowOutOfRangeIndicators dependency property.

C#
public static readonly DependencyProperty ShowOutOfRangeIndicatorsProperty

ValueBorderBrushProperty

DependencyProperty

Identifies the ValueBorderBrush dependency property.

C#
public static readonly DependencyProperty ValueBorderBrushProperty

ValueBrushProperty

DependencyProperty

Identifies the ValueBrush dependency property.

C#
public static readonly DependencyProperty ValueBrushProperty

ValueProperty

DependencyProperty

Identifies the Value dependency property.

C#
public static readonly DependencyProperty ValueProperty

Properties

AppliedBarBorderBrush

Brush

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

C#
public Brush AppliedBarBorderBrush { get; }
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

Brush

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

C#
public Brush AppliedBarBrush { get; }
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

Thickness

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

C#
public Thickness AppliedLabelMargin { get; }
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.

C#
public OutOfRangeRule AppliedOutOfRangeRule { get; }
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

DataTemplate

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

C#
public DataTemplate AppliedOutOfRangeTemplate { get; }
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.

C#
public double BarLeftPercent { get; }
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.

C#
public double BarRightPercent { get; }
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.

C#
public double LabelDistance { get; set; }
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.

C#
public string LabelFormat { get; set; }

LabelPosition

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

C#
public LabelPosition LabelPosition { get; set; }

LabelStyle

Style

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

C#
public Style LabelStyle { get; set; }

LabelText

Gets the text of the label.

C#
public string LabelText { get; }
Remarks:

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

LabelVisibility

Visibility

Gets or sets the Visibility of the label.

C#
public Visibility LabelVisibility { get; set; }

NegativeValueBorderBrush

Brush

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

C#
public Brush NegativeValueBorderBrush { get; set; }

NegativeValueBrush

Brush

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

C#
public Brush NegativeValueBrush { get; set; }

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.

C#
public bool ShowOutOfRangeIndicators { get; set; }

Value

Gets or sets the value.

C#
public double Value { get; set; }

ValueBorderBrush

Brush

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

C#
public Brush ValueBorderBrush { get; set; }

ValueBrush

Brush

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

C#
public Brush ValueBrush { get; set; }

Methods

OnCreateAutomationPeer()

AutomationPeer

Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

The type-specific AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Maximum has changed.

C#
protected override void OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters:eDependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Overrides: RadDataBarBase.OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Minimum has changed.

C#
protected override void OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters:eDependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Overrides: RadDataBarBase.OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)

Called when the OriginValue has changed.

C#
protected override void OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters:eDependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Overrides: RadDataBarBase.OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)

UpdateOutOfRangeTemplates()

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

C#
protected override void UpdateOutOfRangeTemplates()

Overrides: RadDataBarBase.UpdateOutOfRangeTemplates()

In this article
DefinitionConstructorsRadDataBar()FieldsAppliedBarBorderBrushPropertyAppliedBarBrushPropertyAppliedLabelMarginPropertyAppliedOutOfRangeRulePropertyAppliedOutOfRangeTemplatePropertyBarLeftPercentPropertyBarRightPercentPropertyLabelDistancePropertyLabelFormatPropertyLabelPositionPropertyLabelStylePropertyLabelTextPropertyLabelVisibilityPropertyNegativeValueBorderBrushPropertyNegativeValueBrushPropertyShowOutOfRangeIndicatorsPropertyValueBorderBrushPropertyValueBrushPropertyValuePropertyPropertiesAppliedBarBorderBrushAppliedBarBrushAppliedLabelMarginAppliedOutOfRangeRuleAppliedOutOfRangeTemplateBarLeftPercentBarRightPercentLabelDistanceLabelFormatLabelPositionLabelStyleLabelTextLabelVisibilityNegativeValueBorderBrushNegativeValueBrushShowOutOfRangeIndicatorsValueValueBorderBrushValueBrushMethodsOnCreateAutomationPeer()OnInitialized(EventArgs)OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)UpdateOutOfRangeTemplates()
Not finding the help you need?
Contact Support