Class ProgressBarPrimitive

Represents a primitive element that renders progress bars with support for various styles, orientations, and customization options.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
BasePrimitive
FillPrimitive
ProgressBarPrimitive
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.Primitives
Assembly: Telerik.WinControls.dll

Syntax

public class ProgressBarPrimitive : FillPrimitive, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, IPrimitive, IFillElement, IPrimitiveElement, IShapedElement
Remarks

ProgressBarPrimitive extends FillPrimitive to provide comprehensive progress bar rendering capabilities, including linear and circular progress indicators, stepped progress display, and dual-value range support. It supports both determinate and indeterminate progress visualization modes.

The primitive supports various visual styles including gradient fills, custom separators, dash patterns, and different orientations. It can render progress with customizable minimum/maximum ranges and step values, making it suitable for complex progress tracking scenarios.

ProgressBarPrimitive is commonly used in progress controls, loading indicators, status displays, and any UI element requiring visual progress feedback to users.

Constructors

ProgressBarPrimitive()

Declaration
public ProgressBarPrimitive()

Fields

DashProperty

Declaration
public static RadProperty DashProperty
Field Value
RadProperty

HatchProperty

Declaration
public static RadProperty HatchProperty
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

SeparatorColorProperty1

Declaration
public static RadProperty SeparatorColorProperty1
Field Value
RadProperty

SeparatorColorProperty2

Declaration
public static RadProperty SeparatorColorProperty2
Field Value
RadProperty

SeparatorWidthProperty

Declaration
public static RadProperty SeparatorWidthProperty
Field Value
RadProperty

StepProperty

Declaration
public static RadProperty StepProperty
Field Value
RadProperty

StepWidthProperty

Declaration
public static RadProperty StepWidthProperty
Field Value
RadProperty

SweepAngleProperty

Declaration
public static RadProperty SweepAngleProperty
Field Value
RadProperty

ValueProperty1

Declaration
public static RadProperty ValueProperty1
Field Value
RadProperty

ValueProperty2

Declaration
public static RadProperty ValueProperty2
Field Value
RadProperty

Properties

Dash

Indicates whether the progress bar style is dash. If both dash and hash are true, hatch style is chosen.

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

HasImage

Gets or sets a value indicating whether the progress bar has an associated image.

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

true if the progress bar displays an image; otherwise, false.
Remarks

When set to true, this property indicates that the progress bar should consider image rendering in its layout and painting operations. This affects how the progress bar calculates its visual representation and may influence spacing and alignment.

Hatch

Indicates whether the progress bar style is hatch. When true, the style is Hatch. When both dash and hatch are true the style is hatch.

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

Maximum

Gets or sets maximum value for the progress.

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

Minimum

Specifies minimum value for the progress.

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

Orientation

Gets or sets progress bar orientation. Possible values are indicates in ProgressOrientaion enumeration: up, left, bottom, and right.

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

SeparatorColor1

Gets or sets the first color that is used in gradient effect.

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

SeparatorColor2

Gets or sets the second color that is used in gradient effect.

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

SeparatorWidth

Gets or sets separators width in pixels.

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

Step

Gets or sets the step value used for discrete progress increments.

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

An integer value representing the increment amount for step-based progress updates.
Remarks

The step value determines the amount by which the progress value increases when using step-based progress updates. This is useful for operations that complete in discrete, measurable increments rather than continuous progress.

StepWidth

Gets or sets the step width in pixels between separators.

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

SweepAngle

Gets or sets the angle in degrees of the progress bar dash or hatch parts.

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

Value1

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

Declaration
public virtual 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
public virtual 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

GetProgressRectangle()

Declaration
public Rectangle GetProgressRectangle()
Returns
System.Drawing.Rectangle

PaintPrimitive(IGraphics, Single, SizeF)

Draws the primitive on the screen.

Declaration
public override void PaintPrimitive(IGraphics g, float angle, SizeF scale)
Parameters
IGraphics g

System.Single angle

System.Drawing.SizeF scale

Overrides

Extension Methods