Back to all docs
API Reference / Telerik.Windows.Controls / RadDataBar

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.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:
cs-api-definition
[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.

Declaration

cs-api-definition
public RadDataBar()

Fields

AppliedBarBorderBrushProperty

Identifies the AppliedBarBorderBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedBarBorderBrushProperty

Field Value

DependencyProperty

AppliedBarBrushProperty

Identifies the AppliedBarBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedBarBrushProperty

Field Value

DependencyProperty

AppliedLabelMarginProperty

Identifies the AppliedLabelMargin dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedLabelMarginProperty

Field Value

DependencyProperty

AppliedOutOfRangeRuleProperty

Identifies the AppliedOutOfRangeRule dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedOutOfRangeRuleProperty

Field Value

DependencyProperty

AppliedOutOfRangeTemplateProperty

Identifies the AppliedOutOfRangeTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedOutOfRangeTemplateProperty

Field Value

DependencyProperty

BarLeftPercentProperty

Identifies the BarLeftPercent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BarLeftPercentProperty

Field Value

DependencyProperty

BarRightPercentProperty

Identifies the BarRightPercent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BarRightPercentProperty

Field Value

DependencyProperty

LabelDistanceProperty

Identifies the LabelDistance dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelDistanceProperty

Field Value

DependencyProperty

LabelFormatProperty

Identifies the LabelFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelFormatProperty

Field Value

DependencyProperty

LabelPositionProperty

Identifies the LabelPosition dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelPositionProperty

Field Value

DependencyProperty

LabelStyleProperty

Identifies the LabelStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelStyleProperty

Field Value

DependencyProperty

LabelTextProperty

Identifies the LabelText dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelTextProperty

Field Value

DependencyProperty

LabelVisibilityProperty

Identifies the LabelVisibility dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelVisibilityProperty

Field Value

DependencyProperty

NegativeValueBorderBrushProperty

Identifies the NegativeValueBorderBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty NegativeValueBorderBrushProperty

Field Value

DependencyProperty

NegativeValueBrushProperty

Identifies the NegativeValueBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty NegativeValueBrushProperty

Field Value

DependencyProperty

ShowOutOfRangeIndicatorsProperty

Identifies the ShowOutOfRangeIndicators dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ShowOutOfRangeIndicatorsProperty

Field Value

DependencyProperty

ValueBorderBrushProperty

Identifies the ValueBorderBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueBorderBrushProperty

Field Value

DependencyProperty

ValueBrushProperty

Identifies the ValueBrush dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueBrushProperty

Field Value

DependencyProperty

ValueProperty

Identifies the Value dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValueProperty

Field Value

DependencyProperty

Properties

AppliedBarBorderBrush

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

Declaration

cs-api-definition
public Brush AppliedBarBorderBrush { get; }

Property Value

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

cs-api-definition
public Brush AppliedBarBrush { get; }

Property Value

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

cs-api-definition
public Thickness AppliedLabelMargin { get; }

Property Value

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

cs-api-definition
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

cs-api-definition
public DataTemplate AppliedOutOfRangeTemplate { get; }

Property Value

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

cs-api-definition
public double BarLeftPercent { get; }

Property Value

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

cs-api-definition
public double BarRightPercent { get; }

Property Value

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

cs-api-definition
public double LabelDistance { get; set; }

Property Value

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

cs-api-definition
public string LabelFormat { get; set; }

Property Value

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

cs-api-definition
public LabelPosition LabelPosition { get; set; }

Property Value

LabelPosition

LabelStyle

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

Declaration

cs-api-definition
public Style LabelStyle { get; set; }

Property Value

Style

LabelText

Gets the text of the label.

Declaration

cs-api-definition
public string LabelText { get; }

Property Value

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

cs-api-definition
public Visibility LabelVisibility { get; set; }

Property Value

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

cs-api-definition
public Brush NegativeValueBorderBrush { get; set; }

Property Value

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

cs-api-definition
public Brush NegativeValueBrush { get; set; }

Property Value

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

cs-api-definition
public bool ShowOutOfRangeIndicators { get; set; }

Property Value

bool

Value

Gets or sets the value.

Declaration

cs-api-definition
public double Value { get; set; }

Property Value

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

cs-api-definition
public Brush ValueBorderBrush { get; set; }

Property Value

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

cs-api-definition
public Brush ValueBrush { get; set; }

Property Value

Brush

Methods

OnCreateAutomationPeer()

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

Declaration

cs-api-definition
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.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Maximum has changed.

Declaration

cs-api-definition
protected override void OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

e

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Overrides RadDataBarBase.OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Minimum has changed.

Declaration

cs-api-definition
protected override void OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

e

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Overrides RadDataBarBase.OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)

Called when the OriginValue has changed.

Declaration

cs-api-definition
protected override void OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs e)

Parameters

e

DependencyPropertyChangedEventArgs

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.

Declaration

cs-api-definition
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