RadProgressBar
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, IAnalyticsProviderInheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadProgressBar...
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadProgressBar class.
public RadProgressBar()Properties
Gets or sets the background image of the RadProgressBar.
public override Image BackgroundImage { get; set; }Overrides:
Gets or sets the layout of the background image of the RadProgressBar.
public override ImageLayout BackgroundImageLayout { get; set; }Overrides:
Indicates whether the progress bar style is dash. When style is dash the progress line is broken into segments with separators in between them.
public bool Dash { get; set; }Gets the default size for the progress bar control.
protected override Size DefaultSize { get; }Overrides:
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.
public bool Hatch { get; set; }Gets or sets the image displayed in the progress indicator.
public Image Image { get; set; }Gets or sets the alignment of the image of the progress line.
public ContentAlignment ImageAlignment { get; set; }Gets or sets the index of the image from the associated ImageList to display in the progress indicator.
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.2.702.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public int ImageIndex { get; set; }Gets or sets the key of the image from the associated ImageList to display in the progress indicator.
[RelatedImageList("ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.2.702.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }Gets or sets the layout of the image in the progress indicator.
public ImageLayout ImageLayout { get; set; }When style is dash indicates if the progress indicators will progress on steps or smoothly.
public bool IntegralDash { get; set; }Gets or sets the maximum value for the progress.
public int Maximum { get; set; }The maximum.
Gets or sets the minimum value for the progress.
public int Minimum { get; set; }The minimum.
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.
[Browsable(false)]
public RadProgressBarElement ProgressBarElement { get; }Gets or sets the progress orientation: Bottom, Left, Right, Top.
public ProgressOrientation ProgressOrientation { get; set; }Gets or sets the first gradient color for separators
public Color SeparatorColor1 { get; set; }The separator color1.
Gets or sets the second gradient color for separators.
public Color SeparatorColor2 { get; set; }The separator color2.
Gets or sets the third gradient color for separators.
public Color SeparatorColor3 { get; set; }The separator color3.
Gets or sets the fourth gradient color for separators.
public Color SeparatorColor4 { get; set; }The separator color4.
Gets or sets the fourth gradient color for separators.
public int SeparatorGradientAngle { get; set; }The separator gradient angle.
Gets or sets the first color stop in the separator gradient.
public float SeparatorGradientPercentage1 { get; set; }The separator gradient percentage1.
Gets or sets the second color stop in the separator gradient.
public float SeparatorGradientPercentage2 { get; set; }The separator gradient percentage2.
Gets or sets the number of colors used in the separator gradient.
public int SeparatorNumberOfColors { get; set; }The separator number of colors.
Gets or sets the separators width in pixels.
public int SeparatorWidth { get; set; }The width of the separator.
Gets or sets if the progress should be show with percentages.
public bool ShowProgressIndicators { get; set; }Gets or sets a value indicating the amount to increment the current value with.
public int Step { get; set; }The step.
Gets or sets the StepWidth between different separators.
public int StepWidth { get; set; }The width of the step.
Gets or sets the angle at which the dash or hatch lines are tilted.
public int SweepAngle { get; set; }Gets or sets the text associated with this control.
[Bindable(true)]
public override string Text { get; set; }The text.
Overrides:
Gets or sets the alignment of the text content on the drawing surface.
public ContentAlignment TextAlignment { get; set; }Gets or sets the text orientation in the progress bar.
public Orientation TextOrientation { get; set; }Gets or sets the value of the first progress line. There could be two progress lines in the progress bar.
public int Value1 { get; set; }Methods
Creates the child elements that make up the progress bar structure.
protected override void CreateChildItems(RadElement parent)The parent element to which child elements will be added.
Overrides:
Creates and returns a new instance of RadProgressBarElement that provides the core functionality for this progress bar.
protected virtual RadProgressBarElement CreateProgressBarElement()A new RadProgressBarElement instance.
Raises the appropriate event based on the specified ProgressBarEventArgs.
protected virtual void OnPropertyChanged(ProgressBarEventArgs e)The ProgressBarEventArgs instance containing the event data.
Resets background color theme overrides by clearing custom overrides and applying the current theme.
protected override void ResetBackColorThemeOverrides()Overrides:
Resets foreground color theme overrides by clearing custom overrides and applying the current theme.
protected override void ResetForeColorThemeOverrides()Overrides:
Sets theme overrides for the background color by applying the specified color across all visual states.
protected override void SetBackColorThemeOverrides()Overrides:
Sets theme overrides for the foreground color by applying the specified color across all visual states.
protected override void SetForeColorThemeOverrides()Overrides:
Events
Occurs when the dash property is changed.
public event RadProgressBar.ProgressBarHandler DashChangedOccurs when the hatch property is changed.
public event RadProgressBar.ProgressBarHandler HatchChangedOccurs when the integral dash property is changed.
public event RadProgressBar.ProgressBarHandler IntegralDashChangedOccurs when the maximum property is changed.
public event RadProgressBar.ProgressBarHandler MaximumChangedOccurs when the minimum property is changed.
public event RadProgressBar.ProgressBarHandler MinimumChangedOccurs when the progress orientation is changed.
public event RadProgressBar.ProgressBarHandler ProgressOrientationChangedOccurs when the separator color is changed.
public event RadProgressBar.ProgressBarHandler SeparatorColorChangedOccurs when the separator width is changed.
public event RadProgressBar.ProgressBarHandler SeparatorWidthChangedOccurs when show progress indicators is changed.
public event RadProgressBar.ProgressBarHandler ShowProgressIndicatorsChangedOccurs when the step is changed.
public event RadProgressBar.ProgressBarHandler StepChangedOccurs when the step width is changed.
public event RadProgressBar.ProgressBarHandler StepWidthChangedOccurs when the text alignment is changed.
public event RadProgressBar.ProgressBarHandler TextAlignmentChangedOccurs when the text orientation is changed.
public event RadProgressBar.ProgressBarHandler TextOrientationChangedOccurs when the value is changed.
public event RadProgressBar.ProgressBarHandler ValueChanged