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

Class
RadStackedDataBar

Represents a control that stacks data bars, the lengths of which represent values from an items source, in correspondence to the set minimum and maximum.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:
cs-api-definition
[TelerikToolboxCategory("Data Visualization")]
public sealed class RadStackedDataBar : RadDataBarBase

Inheritance: objectRadDataBarBaseRadStackedDataBar

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

RadStackedDataBar()

Initializes a new instance of the RadStackedDataBar class.

Declaration

cs-api-definition
public RadStackedDataBar()

Fields

AppliedOverflowTemplateProperty

Identifies the AppliedOverflowTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedOverflowTemplateProperty

Field Value

DependencyProperty

AppliedUnderflowTemplateProperty

Identifies the AppliedUnderflowTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty AppliedUnderflowTemplateProperty

Field Value

DependencyProperty

BarBorderBrushesProperty

Identifies the BarBorderBrushes dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BarBorderBrushesProperty

Field Value

DependencyProperty

BarBrushesProperty

Identifies the BarBrushes dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty BarBrushesProperty

Field Value

DependencyProperty

DataBarItemsProperty

Identifies the DataBarItems dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DataBarItemsProperty

Field Value

DependencyProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsSourceProperty

Field Value

DependencyProperty

ShowToolTipsProperty

Identifies the ShowToolTips dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ShowToolTipsProperty

Field Value

DependencyProperty

ToolTipFormatProperty

Identifies the ToolTipFormat dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ToolTipFormatProperty

Field Value

DependencyProperty

ToolTipPathProperty

Identifies the ToolTipPath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ToolTipPathProperty

Field Value

DependencyProperty

ValuePathProperty

Identifies the ValuePath dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ValuePathProperty

Field Value

DependencyProperty

Properties

AppliedOverflowTemplate

Gets the overflow template that is applied.

Declaration

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

Property Value

DataTemplate

Remarks

This property is set internally. If the positive sum is greater than the Maximum, the value of this property is the same as the value of the OverflowTemplate property. If the positive sum is less than the Maximum, the value of this property is set to null so that an overflow indication is not shown.

AppliedUnderflowTemplate

Gets the underflow template that is applied.

Declaration

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

Property Value

DataTemplate

Remarks

This property is set internally. If the negative sum is less than the Minimum, the value of this property is the same as the value of the UnderflowTemplate property. If the negative sum is greater than the Minimum, the value of this property is set to null so that an underflow indication is not shown.

BarBorderBrushes

Gets or sets the collection of brushes that are used for the Stroke of the DataBarShapes.

Declaration

cs-api-definition
public BrushCollection BarBorderBrushes { get; set; }

Property Value

BrushCollection

Remarks

Each DataBarShape is assigned a Stroke from the BarBorderBrushes collection. The index of the brush that is assigned corresponds to the index of the data bar shape. For instance if the ItemsSource has 7 items and the BarBorderBrushes collection holds 4 brushes the Stroke of the DataBarShape with index 4 is the brush with index 0 and the Stroke of the DataBarShape with index 5 is the brush with index 1.

BarBrushes

Gets or sets the collection of brushes that are used for the Fill of the DataBarShapes.

Declaration

cs-api-definition
public BrushCollection BarBrushes { get; set; }

Property Value

BrushCollection

Remarks

Each DataBarShape is assigned a Fill from the BarBrushes collection. The index of the brush that is assigned corresponds to the index of the DataBarShape. For instance if the ItemsSource has 7 items and the BarBrushes collection holds 4 brushes the Fill of the DataBarShape with index 3 is the brush with index 3 and the Fill of the DataBarShape with index 4 is the brush with index 0.

DataBarItems

Gets the calculated DataBarDataItems.

Declaration

cs-api-definition
public IEnumerable<DataBarDataItem> DataBarItems { get; }

Property Value

IEnumerable<DataBarDataItem>

Remarks

This property is set internally and modifying this collection should have no effect. This is a collection of items that contain relevant information about a StackedBarItem.

ItemsSource

Gets or sets the ItemsSource.

Declaration

cs-api-definition
public IEnumerable ItemsSource { get; set; }

Property Value

IEnumerable

ShowToolTips

Gets or sets a value indicating whether tool tips should be shown.

Declaration

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

Property Value

bool

ToolTipFormat

Gets or sets the string used for formatting the tool tip string.

Declaration

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

Property Value

string

ToolTipPath

Gets or sets the name of the property from which the tool tip content is extracted.

Declaration

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

Property Value

string

ValuePath

Gets or sets the name of the property from which values are extracted.

Declaration

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

Property Value

string

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 origin value 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()

Updates the applied out of range templates. If the sum of the negative values is less than the Minimum the AppliedUnderflowTemplate is set accordingly, so that an underflow indication is shown. If the sum of the positive values is greater than the Maximum the AppliedOverflowTemplate is set accordingly, so that an overflow indication is shown.

Declaration

cs-api-definition
protected override void UpdateOutOfRangeTemplates()

Overrides RadDataBarBase.UpdateOutOfRangeTemplates()

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