ClassRadProgressBar
Represents a progress bar. You can set progress bar appearance in numerous ways. For example, you can use dash or dash integral style, set separator color and width, set a background image, etc. The RadProgressBar class is a simple wrapper for the RadProgressBarElement class. The latter may be nested in other telerik controls. All UI and logic functionality is implemented by the RadProgressBarElement class. RadProgressBar acts to transfer the events to and from the RadProgressBarElement class.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.UI.dll
Syntax:
public class RadProgressBar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider
Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadProgressBar
Implements:
Inherited Members
Constructors
RadProgressBar()
Initializes a new instance of the RadProgressBar class.
Declaration
public RadProgressBar()
Properties
BackgroundImage
Gets or sets the background image of the RadProgressBar.
Declaration
public override Image BackgroundImage { get; set; }
Property Value
Overrides
BackgroundImageLayout
Gets or sets the layout of the background image of the RadProgressBar.
Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
Overrides
Dash
Indicates whether the progress bar style is dash. When style is dash the progress line is broken into segments with separators in between them.
DefaultSize
Gets the default size for the progress bar control.
Declaration
protected override Size DefaultSize { get; }
Property Value
Overrides
Hatch
Indicates whether the progress bar style is hatch. When style is hatch the progress line is covered with a hatch. You will have to change the SweepAngle in order to see the style.
Image
Gets or sets the image displayed in the progress indicator.
ImageAlignment
Gets or sets the alignment of the image of the progress line.
Declaration
public ContentAlignment ImageAlignment { get; set; }
Property Value
ImageIndex
Gets or sets the index of the image from the associated ImageList to display in the progress indicator.
Declaration
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public int ImageIndex { get; set; }
Property Value
ImageKey
Gets or sets the key of the image from the associated ImageList to display in the progress indicator.
Declaration
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.1.217.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }
Property Value
ImageLayout
Gets or sets the layout of the image in the progress indicator.
Declaration
public ImageLayout ImageLayout { get; set; }
Property Value
IntegralDash
When style is dash indicates if the progress indicators will progress on steps or smoothly.
Maximum
Gets or sets the maximum value for the progress.
Minimum
Gets or sets the minimum value for the progress.
ProgressBarElement
Gets the instance of RadProgressBarElement wrapped by this control. RadProgressBarElement is the main element in the hierarchy tree and encapsulates the actual functionality of RadProgressBar.
Declaration
[Browsable(false)]
public RadProgressBarElement ProgressBarElement { get; }
Property Value
ProgressOrientation
Gets or sets the progress orientation: Bottom, Left, Right, Top.
Declaration
public ProgressOrientation ProgressOrientation { get; set; }
Property Value
SeparatorColor1
Gets or sets the first gradient color for separators
Declaration
public Color SeparatorColor1 { get; set; }
Property Value
The separator color1.
SeparatorColor2
Gets or sets the second gradient color for separators.
Declaration
public Color SeparatorColor2 { get; set; }
Property Value
The separator color2.
SeparatorColor3
Gets or sets the third gradient color for separators.
Declaration
public Color SeparatorColor3 { get; set; }
Property Value
The separator color3.
SeparatorColor4
Gets or sets the fourth gradient color for separators.
Declaration
public Color SeparatorColor4 { get; set; }
Property Value
The separator color4.
SeparatorGradientAngle
Gets or sets the fourth gradient color for separators.
Declaration
public int SeparatorGradientAngle { get; set; }
Property Value
The separator gradient angle.
SeparatorGradientPercentage1
Gets or sets the first color stop in the separator gradient.
Declaration
public float SeparatorGradientPercentage1 { get; set; }
Property Value
The separator gradient percentage1.
SeparatorGradientPercentage2
Gets or sets the second color stop in the separator gradient.
Declaration
public float SeparatorGradientPercentage2 { get; set; }
Property Value
The separator gradient percentage2.
SeparatorNumberOfColors
Gets or sets the number of colors used in the separator gradient.
Declaration
public int SeparatorNumberOfColors { get; set; }
Property Value
The separator number of colors.
SeparatorWidth
Gets or sets the separators width in pixels.
Declaration
public int SeparatorWidth { get; set; }
Property Value
The width of the separator.
ShowProgressIndicators
Gets or sets if the progress should be show with percentages.
Step
Gets or sets a value indicating the amount to increment the current value with.
StepWidth
Gets or sets the StepWidth between different separators.
Declaration
public int StepWidth { get; set; }
Property Value
The width of the step.
SweepAngle
Gets or sets the angle at which the dash or hatch lines are tilted.
Text
Gets or sets the text associated with this control.
Declaration
[Bindable(true)]
public override string Text { get; set; }
Property Value
The text.
Overrides
TextAlignment
Gets or sets the alignment of the text content on the drawing surface.
Declaration
public ContentAlignment TextAlignment { get; set; }
Property Value
TextOrientation
Gets or sets the text orientation in the progress bar.
Declaration
public Orientation TextOrientation { get; set; }
Property Value
Value1
Gets or sets the value of the first progress line. There could be two progress lines in the progress bar.
Methods
CreateChildItems(RadElement)
Creates the child elements that make up the progress bar structure.
Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
parent
The parent element to which child elements will be added.
Overrides
CreateProgressBarElement()
Creates and returns a new instance of RadProgressBarElement that provides the core functionality for this progress bar.
Declaration
protected virtual RadProgressBarElement CreateProgressBarElement()
Returns
A new RadProgressBarElement instance.
OnPropertyChanged(ProgressBarEventArgs)
Raises the appropriate event based on the specified ProgressBarEventArgs.
Declaration
protected virtual void OnPropertyChanged(ProgressBarEventArgs e)
Parameters
e
The ProgressBarEventArgs instance containing the event data.
ResetBackColorThemeOverrides()
Resets background color theme overrides by clearing custom overrides and applying the current theme.
Declaration
protected override void ResetBackColorThemeOverrides()
Overrides
ResetForeColorThemeOverrides()
Resets foreground color theme overrides by clearing custom overrides and applying the current theme.
Declaration
protected override void ResetForeColorThemeOverrides()
Overrides
SetBackColorThemeOverrides()
Sets theme overrides for the background color by applying the specified color across all visual states.
Declaration
protected override void SetBackColorThemeOverrides()
Overrides
SetForeColorThemeOverrides()
Sets theme overrides for the foreground color by applying the specified color across all visual states.
Declaration
protected override void SetForeColorThemeOverrides()
Overrides
Events
DashChanged
Occurs when the dash property is changed.
Declaration
public event RadProgressBar.ProgressBarHandler DashChanged
Event Value
HatchChanged
Occurs when the hatch property is changed.
Declaration
public event RadProgressBar.ProgressBarHandler HatchChanged
Event Value
IntegralDashChanged
Occurs when the integral dash property is changed.
Declaration
public event RadProgressBar.ProgressBarHandler IntegralDashChanged
Event Value
MaximumChanged
Occurs when the maximum property is changed.
Declaration
public event RadProgressBar.ProgressBarHandler MaximumChanged
Event Value
MinimumChanged
Occurs when the minimum property is changed.
Declaration
public event RadProgressBar.ProgressBarHandler MinimumChanged
Event Value
ProgressOrientationChanged
Occurs when the progress orientation is changed.
Declaration
public event RadProgressBar.ProgressBarHandler ProgressOrientationChanged
Event Value
SeparatorColorChanged
Occurs when the separator color is changed.
Declaration
public event RadProgressBar.ProgressBarHandler SeparatorColorChanged
Event Value
SeparatorWidthChanged
Occurs when the separator width is changed.
Declaration
public event RadProgressBar.ProgressBarHandler SeparatorWidthChanged
Event Value
ShowProgressIndicatorsChanged
Occurs when show progress indicators is changed.
Declaration
public event RadProgressBar.ProgressBarHandler ShowProgressIndicatorsChanged
Event Value
StepChanged
Occurs when the step is changed.
Declaration
public event RadProgressBar.ProgressBarHandler StepChanged
Event Value
StepWidthChanged
Occurs when the step width is changed.
Declaration
public event RadProgressBar.ProgressBarHandler StepWidthChanged
Event Value
TextAlignmentChanged
Occurs when the text alignment is changed.
Declaration
public event RadProgressBar.ProgressBarHandler TextAlignmentChanged
Event Value
TextOrientationChanged
Occurs when the text orientation is changed.
Declaration
public event RadProgressBar.ProgressBarHandler TextOrientationChanged
Event Value
ValueChanged
Occurs when the value is changed.
Declaration
public event RadProgressBar.ProgressBarHandler ValueChanged
Event Value