Class 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.

Inheritance
System.Object
RadControl
RadProgressBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadProgressBar : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider

Constructors

RadProgressBar()

Initializes a new instance of the RadProgressBar class.

Declaration
public RadProgressBar()

Properties

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

BackgroundImage

Gets or sets the background image of the RadProgressBar.

Declaration
public override Image BackgroundImage { get; set; }
Property Value
System.Drawing.Image

BackgroundImageLayout

Gets or sets the layout of the background image of the RadProgressBar.

Declaration
public override ImageLayout BackgroundImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

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.

Declaration
[RadPropertyDefaultValue("Dash", typeof(RadProgressBarElement))]
public bool Dash { get; set; }
Property Value
System.Boolean

DefaultSize

Gets the default size for the progress bar control.

Declaration
protected override Size DefaultSize { get; }
Property Value
System.Drawing.Size

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.

Declaration
[RadPropertyDefaultValue("Dash", typeof(RadProgressBarElement))]
public bool Hatch { get; set; }
Property Value
System.Boolean

Image

Gets or sets the image displayed in the progress indicator.

Declaration
[RadDescription("Image", typeof(RadProgressBarElement))]
public Image Image { get; set; }
Property Value
System.Drawing.Image

ImageAlignment

Gets or sets the alignment of the image of the progress line.

Declaration
public ContentAlignment ImageAlignment { get; set; }
Property Value
System.Drawing.ContentAlignment

ImageIndex

Gets or sets the index of the image from the associated System.Windows.Forms.ImageList to display in the progress indicator.

Declaration
[RadDefaultValue("ImageIndex", typeof(LightVisualElement))]
[RadDescription("ImageIndex", typeof(RadProgressBarElement))]
public int ImageIndex { get; set; }
Property Value
System.Int32

ImageKey

Gets or sets the key of the image from the associated System.Windows.Forms.ImageList to display in the progress indicator.

Declaration
[RadDefaultValue("ImageKey", typeof(LightVisualElement))]
[RadDescription("ImageKey", typeof(RadProgressBarElement))]
public string ImageKey { get; set; }
Property Value
System.String

ImageLayout

Gets or sets the layout of the image in the progress indicator.

Declaration
[RadDefaultValue("BackgroundImageLayout", typeof(LightVisualElement))]
[RadDescription("ImageLayout", typeof(RadProgressBarElement))]
public ImageLayout ImageLayout { get; set; }
Property Value
System.Windows.Forms.ImageLayout

IntegralDash

When style is dash indicates if the progress indicators will progress on steps or smoothly.

Declaration
[RadPropertyDefaultValue("IntegralDash", typeof(RadProgressBarElement))]
public bool IntegralDash { get; set; }
Property Value
System.Boolean

Maximum

Gets or sets the maximum value for the progress.

Declaration
[RadPropertyDefaultValue("Maximum", typeof(RadProgressBarElement))]
public int Maximum { get; set; }
Property Value
System.Int32

The maximum.

Minimum

Gets or sets the minimum value for the progress.

Declaration
[RadPropertyDefaultValue("Minimum", typeof(RadProgressBarElement))]
public int Minimum { get; set; }
Property Value
System.Int32

The minimum.

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
public RadProgressBarElement ProgressBarElement { get; }
Property Value
RadProgressBarElement

ProgressOrientation

Gets or sets the progress orientation: Bottom, Left, Right, Top.

Declaration
[RadPropertyDefaultValue("ProgressOrientation", typeof(RadProgressBarElement))]
public ProgressOrientation ProgressOrientation { get; set; }
Property Value
ProgressOrientation

SeparatorColor1

Gets or sets the first gradient color for separators

Declaration
[RadPropertyDefaultValue("SeparatorColor1", typeof(SeparatorsElement))]
public Color SeparatorColor1 { get; set; }
Property Value
System.Drawing.Color

The separator color1.

SeparatorColor2

Gets or sets the second gradient color for separators.

Declaration
[RadPropertyDefaultValue("SeparatorColor2", typeof(SeparatorsElement))]
public Color SeparatorColor2 { get; set; }
Property Value
System.Drawing.Color

The separator color2.

SeparatorColor3

Gets or sets the third gradient color for separators.

Declaration
[RadPropertyDefaultValue("SeparatorColor3", typeof(SeparatorsElement))]
public Color SeparatorColor3 { get; set; }
Property Value
System.Drawing.Color

The separator color3.

SeparatorColor4

Gets or sets the fourth gradient color for separators.

Declaration
[RadPropertyDefaultValue("SeparatorColor4", typeof(SeparatorsElement))]
public Color SeparatorColor4 { get; set; }
Property Value
System.Drawing.Color

The separator color4.

SeparatorGradientAngle

Gets or sets the fourth gradient color for separators.

Declaration
[RadPropertyDefaultValue("SeparatorGradientAngle", typeof(RadProgressBarElement))]
public int SeparatorGradientAngle { get; set; }
Property Value
System.Int32

The separator gradient angle.

SeparatorGradientPercentage1

Gets or sets the first color stop in the separator gradient.

Declaration
[RadPropertyDefaultValue("SeparatorGradientPercentage1", typeof(RadProgressBarElement))]
public float SeparatorGradientPercentage1 { get; set; }
Property Value
System.Single

The separator gradient percentage1.

SeparatorGradientPercentage2

Gets or sets the second color stop in the separator gradient.

Declaration
[RadPropertyDefaultValue("SeparatorGradientPercentage2", typeof(RadProgressBarElement))]
public float SeparatorGradientPercentage2 { get; set; }
Property Value
System.Single

The separator gradient percentage2.

SeparatorNumberOfColors

Gets or sets the number of colors used in the separator gradient.

Declaration
[RadPropertyDefaultValue("SeparatorGradientPercentage2", typeof(RadProgressBarElement))]
public int SeparatorNumberOfColors { get; set; }
Property Value
System.Int32

The separator number of colors.

SeparatorWidth

Gets or sets the separators width in pixels.

Declaration
[RadPropertyDefaultValue("SeparatorsWidth", typeof(RadProgressBarElement))]
public int SeparatorWidth { get; set; }
Property Value
System.Int32

The width of the separator.

ShowProgressIndicators

Gets or sets if the progress should be show with percentages.

Declaration
[RadPropertyDefaultValue("ShowProgressIndicator", typeof(RadProgressBarElement))]
public bool ShowProgressIndicators { get; set; }
Property Value
System.Boolean

Step

Gets or sets a value indicating the amount to increment the current value with.

Declaration
[RadPropertyDefaultValue("Step", typeof(RadProgressBarElement))]
public int Step { get; set; }
Property Value
System.Int32

The step.

StepWidth

Gets or sets the StepWidth between different separators.

Declaration
[RadPropertyDefaultValue("StepWidth", typeof(RadProgressBarElement))]
public int StepWidth { get; set; }
Property Value
System.Int32

The width of the step.

SweepAngle

Gets or sets the angle at which the dash or hatch lines are tilted.

Declaration
[RadPropertyDefaultValue("SweepAngle", typeof(RadProgressBarElement))]
public int SweepAngle { get; set; }
Property Value
System.Int32

Text

Gets or sets the text associated with this control.

Declaration
[RadDefaultValue("Text", typeof(RadProgressBarElement))]
public override string Text { get; set; }
Property Value
System.String

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
System.Drawing.ContentAlignment

TextOrientation

Gets or sets the text orientation in the progress bar.

Declaration
[RadPropertyDefaultValue("TextOrientation", typeof(RadProgressBarElement))]
public Orientation TextOrientation { get; set; }
Property Value
System.Windows.Forms.Orientation

Value1

Gets or sets the value of the first progress line. There could be two progress lines in the progress bar.

Declaration
[RadPropertyDefaultValue("Value1", typeof(RadProgressBarElement))]
public int Value1 { get; set; }
Property Value
System.Int32

Value2

Gets or sets the value of the second progress line. There could be two progress lines in the progress bar.

Declaration
[RadPropertyDefaultValue("Value2", typeof(RadProgressBarElement))]
public int Value2 { get; set; }
Property Value
System.Int32

Methods

CreateChildItems(RadElement)

Creates the child elements that make up the progress bar structure.

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement 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
RadProgressBarElement

A new RadProgressBarElement instance.

OnPropertyChanged(ProgressBarEventArgs)

Raises the appropriate event based on the specified ProgressBarEventArgs.

Declaration
protected virtual void OnPropertyChanged(ProgressBarEventArgs e)
Parameters
ProgressBarEventArgs 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 Type
RadProgressBar.ProgressBarHandler

HatchChanged

Occurs when the hatch property is changed.

Declaration
public event RadProgressBar.ProgressBarHandler HatchChanged
Event Type
RadProgressBar.ProgressBarHandler

IntegralDashChanged

Occurs when the integral dash property is changed.

Declaration
public event RadProgressBar.ProgressBarHandler IntegralDashChanged
Event Type
RadProgressBar.ProgressBarHandler

MaximumChanged

Occurs when the maximum property is changed.

Declaration
public event RadProgressBar.ProgressBarHandler MaximumChanged
Event Type
RadProgressBar.ProgressBarHandler

MinimumChanged

Occurs when the minimum property is changed.

Declaration
public event RadProgressBar.ProgressBarHandler MinimumChanged
Event Type
RadProgressBar.ProgressBarHandler

ProgressOrientationChanged

Occurs when the progress orientation is changed.

Declaration
public event RadProgressBar.ProgressBarHandler ProgressOrientationChanged
Event Type
RadProgressBar.ProgressBarHandler

SeparatorColorChanged

Occurs when the separator color is changed.

Declaration
public event RadProgressBar.ProgressBarHandler SeparatorColorChanged
Event Type
RadProgressBar.ProgressBarHandler

SeparatorWidthChanged

Occurs when the separator width is changed.

Declaration
public event RadProgressBar.ProgressBarHandler SeparatorWidthChanged
Event Type
RadProgressBar.ProgressBarHandler

ShowProgressIndicatorsChanged

Occurs when show progress indicators is changed.

Declaration
public event RadProgressBar.ProgressBarHandler ShowProgressIndicatorsChanged
Event Type
RadProgressBar.ProgressBarHandler

StepChanged

Occurs when the step is changed.

Declaration
public event RadProgressBar.ProgressBarHandler StepChanged
Event Type
RadProgressBar.ProgressBarHandler

StepWidthChanged

Occurs when the step width is changed.

Declaration
public event RadProgressBar.ProgressBarHandler StepWidthChanged
Event Type
RadProgressBar.ProgressBarHandler

TextAlignmentChanged

Occurs when the text alignment is changed.

Declaration
public event RadProgressBar.ProgressBarHandler TextAlignmentChanged
Event Type
RadProgressBar.ProgressBarHandler

TextOrientationChanged

Occurs when the text orientation is changed.

Declaration
public event RadProgressBar.ProgressBarHandler TextOrientationChanged
Event Type
RadProgressBar.ProgressBarHandler

ValueChanged

Occurs when the value is changed.

Declaration
public event RadProgressBar.ProgressBarHandler ValueChanged
Event Type
RadProgressBar.ProgressBarHandler

Extension Methods