Loading...

Class RadDataBarBase

The base class for RadDataBars implementing common properties and logic.

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

Syntax

public abstract class RadDataBarBase : Control

Constructors

RadDataBarBase()

Initializes a new instance of the RadDataBarBase class.

Declaration
protected RadDataBarBase()

Fields

AppliedAxisMarginProperty

Identifies the AppliedAxisMargin dependency property.

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

AppliedAxisVisibilityProperty

Identifies the AppliedAxisVisibility dependency property.

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

AxisStrokeProperty

Identifies the AxisStroke dependency property.

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

AxisStyleProperty

Identifies the AxisStyle dependency property.

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

AxisVisibilityProperty

Identifies the AxisVisibility dependency property.

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

BarBorderThicknessProperty

Identifies the BarBorderThickness dependency property.

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

BarHeightPercentProperty

Identifies the BarHeightPercent dependency property.

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

BarStyleProperty

Identifies the BarStyle dependency property.

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

MaximumProperty

Identifies the Maximum dependency property.

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

MinimumProperty

Identifies the Minimum dependency property.

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

OriginValueProperty

Identifies the OriginValue dependency property.

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

OverflowTemplateProperty

Identifies the OverflowTemplate dependency property.

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

UnderflowTemplateProperty

Identifies the UnderflowTemplate dependency property.

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

Properties

AppliedAxisMargin

Gets the Margin that is actually applied to the axis.

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

Remarks

This property is set internally depending on the Minimum, Maximum, OriginValue properties and the ActualWidth of the data bar.

AppliedAxisVisibility

Gets the visibility that is actually applied to the axis.

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

Remarks

This property is set internally depending on the AxisVisibility property and whether the OriginValue is between the Minimum and Maximum.

AxisStroke

Gets or sets the stroke of the axis, which is positioned vertically at the origin value.

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

AxisStyle

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

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

Remarks

The axis is the vertical line positioned at the origin value.

AxisVisibility

Gets or sets the visibility of the axis, which is positioned vertically at the origin value.

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

BarBorderThickness

Gets or sets the Stroke of the DataBarShape.

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

BarHeightPercent

Gets or sets the height percent (from 0 to 1) of the bar shape.

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

BarStyle

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

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

Maximum

Gets or sets the Maximum.

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

Minimum

Gets or sets the Minimum.

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

OriginValue

Gets or sets the origin value.

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

OverflowTemplate

Gets or sets the OverflowTemplate. This is used to denote that (and is shown only if) the value (in DataBar) or the positive sum (in StackedDataBar) is greater than the specified Maximum.

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

UnderflowTemplate

Gets or sets the UnderflowTemplate. This is used to denote that (and is shown only if) the value (in DataBar) or the negative sum (in StackedDataBar) is less than the specified Minimum.

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

Methods

MeasureOverride(Size)

Overrides the Measure pass to define a specific behavior for measuring.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

Returns
System.Windows.Size

NormalizeAndCoerceValue(Double)

Normalizes the value in correspondence to the minimum and maximum and coerces it to be a number between 0 and 1.

Declaration
protected double NormalizeAndCoerceValue(double value)
Parameters
System.Double value

The value that is to be normalized and coerced.
Returns
System.Double

The coerced normalized value.
Remarks

For instance the normalized value of 1120 is 1.0 if the minimum is 1000 and maximum is 1100. The normalized value of 1000 is 0.0 if the minimum is 2000 and maximum is 3000.

NormalizeValue(Double)

Normalizes the value in correspondence to the Minimum and Maximum.

Declaration
protected double NormalizeValue(double value)
Parameters
System.Double value

The value that is to be normalized.
Returns
System.Double

The normalized value.
Remarks

For example, the normalized value of 140 is 0.4 if the minimum is 100 and maximum is 200. The normalized value of 1120 is 1.2 if the minimum is 1000 and maximum is 1100.

OnMaximumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Maximum has changed.

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

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

OnMinimumPropertyChanged(DependencyPropertyChangedEventArgs)

Called when the Minimum has changed.

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

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

OnOriginValuePropertyChanged(DependencyPropertyChangedEventArgs)

Called when the OriginValue has changed.

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

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

UpdateOutOfRangeTemplates()

Called when the visibility of the out-of-range templates should be updated.

Declaration
protected virtual void UpdateOutOfRangeTemplates()

Extension Methods