Class RadProgressBar

The RadProgressBar control can be used to to indicate the progress of an operation. It gives to an end-user visual feedback about an operation he is waiting for to complete.

Inheritance
System.Object
RadProgressBar
RadCircularProgressBar
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.dll

Syntax

[TelerikToolboxCategory("Data")]
[Themable]
public class RadProgressBar : RangeBase, IThemable
Remarks

The RadProgressBar control should be used as a visual indication of the progress of an operation. The developer is responsible for programmatically updating the value of the RadProgressBar, while the control takes care of the visual representation of its value.

Constructors

RadProgressBar()

Initializes a new instance of the RadProgressBar class.

Declaration
public RadProgressBar()

Fields

ContentForegroundProperty

Identifies the ContentForeground property.

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

ContentProperty

Identifies the Content property.

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

ContentStringFormatProperty

Identifies the ContentStringFormat dependency property.

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

ContentTemplateProperty

Identifies the ContentTemplate property.

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

ContentTemplateSelectorProperty

Identifies the DropDownContentTemplateSelector property.

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

IsIndeterminateProperty

Identifies the IsIndeterminate Property.

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

OrientationProperty

Identifies the Orientation property.

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

SkipValueProperty

Identifies the SkipValue Property.

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

Properties

Content

Gets or sets the Content property. This is a dependency property.

Declaration
public object Content { get; set; }
Property Value
System.Object

ContentForeground

Gets or sets the ContentForeground property. This is a dependency property.

Declaration
public SolidColorBrush ContentForeground { get; set; }
Property Value
System.Windows.Media.SolidColorBrush

ContentStringFormat

Gets or sets the content string format of the progress bar.

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

ContentTemplate

Gets or sets the ContentTemplate property. This is a dependency property.

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

ContentTemplateSelector

Gets or sets the template-selector used to display the content. This is a dependency property.

Declaration
public DataTemplateSelector ContentTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

IsIndeterminate

Gets or sets a value indicating whether this instance is indeterminate.

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

True if this instance is indeterminate; otherwise, false.

Orientation

Gets or sets the direction of filling of the control. This is a dependency property.

Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Controls.Orientation

One of the Orientation values. The default value is Horizontal.
Remarks

Use the ExpandMode property to specify the way RadPanelBar should behave after an item is expanded. The available options are:

Examples

The following example demonstrates how to programmatically set the Orientation property of a RadProgressBar control.

void Page_Load(object sender, EventArgs e)
{
RadProgressBar myProgressBar = new RadProgressBar();
myProgressBar.Orientation = Orientation.Vertical;
}

SkipValue

Gets or sets a value indicating the offset from which the ProgressBar indicator should start from. This is a dependency property.

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

Methods

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

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

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnMaximumChanged(Double, Double)

Called when the System.Windows.Controls.Primitives.RangeBase.Maximum property changes.

Declaration
protected override void OnMaximumChanged(double oldMaximum, double newMaximum)
Parameters
System.Double oldMaximum

Old value of the System.Windows.Controls.Primitives.RangeBase.Maximum property.
System.Double newMaximum

New value of the System.Windows.Controls.Primitives.RangeBase.Maximum property.

OnMinimumChanged(Double, Double)

Called when the System.Windows.Controls.Primitives.RangeBase.Minimum property changes.

Declaration
protected override void OnMinimumChanged(double oldMinimum, double newMinimum)
Parameters
System.Double oldMinimum

Old value of the System.Windows.Controls.Primitives.RangeBase.Minimum property.
System.Double newMinimum

New value of the System.Windows.Controls.Primitives.RangeBase.Minimum property.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

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

OnValueChanged(Double, Double)

Raises the System.Windows.Controls.Primitives.RangeBase.ValueChanged routed event.

Declaration
protected override void OnValueChanged(double oldValue, double newValue)
Parameters
System.Double oldValue

Old value of the System.Windows.Controls.Primitives.RangeBase.Value property.
System.Double newValue

New value of the System.Windows.Controls.Primitives.RangeBase.Value property.

ResetTheme()

Resets the theme.

Declaration
public void ResetTheme()

Extension Methods