Class RadProgressBarElement

Represents a progress bar element. RadProgressBar is a simple wrapper for RadProgressBarElement. The latter may be included in other telerik controls. All graphical and logic functionality is implemented by RadProgressBarElement. The RadProgressBar acts to transfer the events to and from its RadProgressBarElement instance.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadProgressBarElement
RadTaskDialogProgressBarElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[ComVisible(false)]
public class RadProgressBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadProgressBarElement()

Declaration
public RadProgressBarElement()

Fields

DashProperty

Declaration
public static RadProperty DashProperty
Field Value
RadProperty

HatchProperty

Declaration
public static RadProperty HatchProperty
Field Value
RadProperty

IntegralDashProperty

Declaration
public static RadProperty IntegralDashProperty
Field Value
RadProperty

IsVerticalProperty

Declaration
public static RadProperty IsVerticalProperty
Field Value
RadProperty

MaximumProperty

Declaration
public static RadProperty MaximumProperty
Field Value
RadProperty

MinimumProperty

Declaration
public static RadProperty MinimumProperty
Field Value
RadProperty

ProgressOrientationProperty

Declaration
public static RadProperty ProgressOrientationProperty
Field Value
RadProperty

ShowProgressIndicatorsProperty

Declaration
public static RadProperty ShowProgressIndicatorsProperty
Field Value
RadProperty

StepProperty

Declaration
public static RadProperty StepProperty
Field Value
RadProperty

ValueProperty1

Declaration
public static RadProperty ValueProperty1
Field Value
RadProperty

ValueProperty2

Declaration
public static RadProperty ValueProperty2
Field Value
RadProperty

Properties

Dash

Gets or sets the style to dash.

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

Hatch

Gets or sets the style to hatch.

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

Image

Gets or sets the progress bar indicator image.

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

Overrides

ImageAlignment

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

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

Overrides

ImageIndex

Gets or sets the image index of the progress bar indicator image.

Declaration
public override int ImageIndex { get; set; }
Property Value
System.Int32

Overrides

ImageKey

Gets or sets the image key for the progress bar indicator image.

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

Overrides

ImageLayout

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

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

Overrides

IndicatorElement1

Gets an instance of the UpperProgressIndicatorElement class that represents the progress indicator of the progress bar.

Declaration
public UpperProgressIndicatorElement IndicatorElement1 { get; }
Property Value
UpperProgressIndicatorElement

IndicatorElement2

Gets an instance of the ProgressIndicatorElement class that represents the progress bar indicator.

Declaration
public ProgressIndicatorElement IndicatorElement2 { get; }
Property Value
ProgressIndicatorElement

IntegralDash

Gets or sets the style to integral dash. To set IntegralDash you need to first set dash to true.

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

Maximum

Gets or sets the maximum possible value for the progress bar Value1(2).

Declaration
public int Maximum { get; set; }
Property Value
System.Int32

Minimum

Gets or sets the minimum possible value for the progress bar Value1(2).

Declaration
public int Minimum { get; set; }
Property Value
System.Int32

ProgressOrientation

Gets or sets the progress orientation of the progress bar indicator. Bottom, Left, Right, Top

Declaration
public ProgressOrientation ProgressOrientation { get; set; }
Property Value
ProgressOrientation

SeparatorColor1

Gets or sets the first gradient color for separators

Declaration
public Color SeparatorColor1 { get; set; }
Property Value
System.Drawing.Color

The separator color1.

SeparatorColor2

Gets or sets the second gradient color for separators

Declaration
public Color SeparatorColor2 { get; set; }
Property Value
System.Drawing.Color

The separator color2.

SeparatorColor3

Gets or sets the third gradient color for separators

Declaration
public Color SeparatorColor3 { get; set; }
Property Value
System.Drawing.Color

The separator color3.

SeparatorColor4

Gets or sets the fourth gradient color for separators

Declaration
public Color SeparatorColor4 { get; set; }
Property Value
System.Drawing.Color

The separator color4.

SeparatorGradientAngle

Gets or sets the angle of the separators gradient

Declaration
public int SeparatorGradientAngle { get; set; }
Property Value
System.Int32

SeparatorGradientPercentage1

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

Declaration
public float SeparatorGradientPercentage1 { get; set; }
Property Value
System.Single

SeparatorGradientPercentage2

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

Declaration
public float SeparatorGradientPercentage2 { get; set; }
Property Value
System.Single

SeparatorNumberOfColors

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

Declaration
public int SeparatorNumberOfColors { get; set; }
Property Value
System.Int32

SeparatorsElement

Gets an instance of the SeparatorsElement class that represents the separators on the progress bar indicator.

Declaration
public SeparatorsElement SeparatorsElement { get; }
Property Value
SeparatorsElement

SeparatorWidth

Gets or sets the separators width in pixels.

Declaration
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
public bool ShowProgressIndicators { get; set; }
Property Value
System.Boolean

Step

Gets or sets the value with which the progress bar Value1(2) will increments/decrements.

Declaration
public int Step { get; set; }
Property Value
System.Int32

StepWidth

Gets or sets the step width in pixels with which the progress bar indicator will move if style is dash.

Declaration
public int StepWidth { get; set; }
Property Value
System.Int32

SweepAngle

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

Declaration
public int SweepAngle { get; set; }
Property Value
System.Int32

Text

Gets or sets the text associated with this element.

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

Overrides

TextElement

Gets an instance of the ProgressBarTextElement class that represents the text of the progress bar.

Declaration
public ProgressBarTextElement TextElement { get; }
Property Value
ProgressBarTextElement

Value1

Gets or sets the value for the first progress indicator.

Declaration
public int Value1 { get; set; }
Property Value
System.Int32

Value2

Gets or sets the value for the second progress indicator.

Declaration
public int Value2 { get; set; }
Property Value
System.Int32

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

CallCreateChildElements()

Creates the child elements and sets their locally applied values as Default

Declaration
protected override void CallCreateChildElements()
Overrides

DecrementValue1(Int32)

Decrements Value1 with the given argument value.

Declaration
public void DecrementValue1(int value)
Parameters
System.Int32 value

The value.

DecrementValue2(Int32)

Decrements Value2 with the given argument value.

Declaration
public void DecrementValue2(int value)
Parameters
System.Int32 value

The value.

GetHorizontalProgressIndicatorFinalSize(RectangleF, Int32, Int32)

Gets the final size of a horizontal progress indicator.

Declaration
protected RectangleF GetHorizontalProgressIndicatorFinalSize(RectangleF clientRect, int value, int step)
Parameters
System.Drawing.RectangleF clientRect

The client rect.
System.Int32 value

The value.
System.Int32 step

The step.
Returns
System.Drawing.RectangleF

GetProgressIndicatorFinalSize(ProgressIndicatorElement, RectangleF, Int32)

Gets the final size of the progress indicator.

Declaration
protected RectangleF GetProgressIndicatorFinalSize(ProgressIndicatorElement element, RectangleF clientRect, int value)
Parameters
ProgressIndicatorElement element

The element.
System.Drawing.RectangleF clientRect

The client rect.
System.Int32 value

The value.
Returns
System.Drawing.RectangleF

GetSeparatorsFinalSize(RectangleF, RectangleF)

Gets the final size of the separators.

Declaration
protected RectangleF GetSeparatorsFinalSize(RectangleF progressBar1Rectangle, RectangleF progressBar2Rectangle)
Parameters
System.Drawing.RectangleF progressBar1Rectangle

The progress bar1 rectangle.
System.Drawing.RectangleF progressBar2Rectangle

The progress bar2 rectangle.
Returns
System.Drawing.RectangleF

GetVerticalProgressIndicatorFinalSize(RectangleF, Int32, Int32)

Gets the final size of a vertical progress indicator.

Declaration
protected RectangleF GetVerticalProgressIndicatorFinalSize(RectangleF clientRect, int value, int step)
Parameters
System.Drawing.RectangleF clientRect

The client rect.
System.Int32 value

The value.
System.Int32 step

The step.
Returns
System.Drawing.RectangleF

IncrementValue1(Int32)

Increments Value1 with the given argument value.

Declaration
public void IncrementValue1(int value)
Parameters
System.Int32 value

The value.

IncrementValue2(Int32)

Increments Value2 with the given argument value.

Declaration
public void IncrementValue2(int value)
Parameters
System.Int32 value

The value.

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs instance containing the event data.
Overrides

PerformStepBackValue1()

Reverses the advance of the current position of the second progress bar by the amount of the Step property.

Declaration
public void PerformStepBackValue1()

PerformStepBackValue2()

Advances the current position of the first progress bar by the amount of the Step property.

Declaration
public void PerformStepBackValue2()

PerformStepValue1()

Advances the current position of the progress bar by the amount of the Step property

Declaration
public void PerformStepValue1()

PerformStepValue2()

Advances the current position of the first progress bar by the amount of the Step property.

Declaration
public void PerformStepValue2()

Extension Methods