ProgressBar - ahatornn/clforms GitHub Wiki

ProgressBar

ClForms.Elements.ProgressBar
Represents a Windows progress bar control

public class ProgressBar: Control, IElementStyle<ProgressBar>

Inheritance Control -> ProgressBar
Derived IElementStyle<ProgressBar>

Examples

The following code example creates a ProgressBar control.

var targetProgressBar = new ProgressBar()
{
    Minimum = 0,
    Maximum = 200,
    Value = 50,
    SelectedBackground = Color.DarkBlue,
    Background = Color.Gray,
};

You can find more examples of using the CheckBoxGroup in this project

Remarks

The Maximum and Minimum properties define the range of values to represent the progress of a task. The Minimum property is typically set to a value of 0, and the Maximum property is typically set to a value indicating the completion of a task. For example, to properly display the progress when copying a group of files, the Maximum property could be set to the total number of files to be copied.

The Value property represents the progress that the application has made toward completing the operation. The value displayed by the ProgressBar only approximates the current value of the Value property. Based on the size of the ProgressBar, the Value property determines when to display the next block or increase the size of the bar.

Constructors

Syntax Description
ProgressBar() Initialize a new ProgressBar instance

Properties

Name Type Description
AutoSize bool Gets or sets a value indicating whether the control is resized in accordance with its contents
Background Color Gets or sets a brush that describes the background of a control
BackgroundIsTransparent bool Gets a value indicating whether the Background has Color.NotSet
Bounds Rect Gets the size and location of the control including its nonclient elements, in points, relative to the parent control
DesiredSize Size Gets the size that this element computed during the measure pass of the layout process
DrawingContext IDrawingContext Gets a value of the drawing context
Foreground Color Gets or sets a brush that describes the text of a control
ForegroundIsTransparent bool Gets a value indicating whether the Foreground has Color.NotSet
Height int? Gets or sets the height of the control
Id long Gets a value of the control's identifier
IsMeasureValid bool Gets a value indicating whether component sizing was performed
IsVisualValid bool Gets a value indicating whether the component is being re-rendered
Location Point Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container
Margin Thickness Gets or sets the outer margin of an element
Maximum int Gets or sets the maximum value of the range of the control
Minimum int Gets or sets the minimum value of the range of the control
Padding Thickness Gets or sets a Thickness value that describes the amount of space between a control and its child element
Parent ContentControl Gets or sets the parent container of the control
SelectedBackground Color Gets or sets the background color of the progress indicator
SelectedForeground Color Gets or sets the text color of the progress indicator
ShowValue bool Gets or sets whether the value should be reflected inside the component
Tag object Gets or sets the object that contains data about the control
Value int Gets or sets the current position of the progress bar
ValueAsPerCent bool Gets or sets whether the value should be displayed inside the component as a percentage, provided that the ShowValue is true
Width int? Gets or sets the width of the control

Methods

Syntax Description
Arrange(Rect) Positions child elements and determines a size for a Control. Parent elements call this method from their Arrange(Rect) implementation to form a recursive layout update
InvalidateMeasure() Invalidates the measurement state (layout) for the element
InvalidateMeasureIfAutoSize() Invalidates the measurement state (layout) for the element if AutoSize property is true otherwise invalidates the rendering of the element
InvalidateVisual() Invalidates the rendering of the element, and forces a complete new layout pass. OnRender(IDrawingContext) is called after the layout cycle is completed
Measure(Size) Updates DesiredSize of a Control. Parent elements call this method from their own Measure(Size) implementations to form a recursive layout update
OnRender(IDrawingContext) Filling a pseudographics drawing context
ParentWindow() Gets the form the control is in
SetStyle(Action) Defines actions with an element style

Events

Event Description
OnAutoSizeChanged Occurs when the value of the AutoSize property changes
OnBackgroundChanged Occurs when the value of the Background property changes
OnForegroundChanged Occurs when the value of the Foreground property changes
OnHeightChanged Occurs when the value of the Height property changes
OnMarginChanged Occurs when the value of the Margin property changes
OnMaximumChanged Occurs when the value of the Maximum property changes
OnMinimumChanged Occurs when the value of the Minimum property changes
OnPaddingChanged Occurs when the value of the Padding property changes
OnParentChanged Occurs when the value of the Parent property changes
OnSelectedBackgroundChanged Occurs when the value of the SelectedBackground property changes
OnSelectedForegroundChanged Occurs when the value of the SelectedForeground property changes
OnShowValueChanged Occurs when the value of the ShowValue property changes
OnTagChanged Occurs when the value of the Tag property changes
OnValueAsPerCentChanged Occurs when the value of the ValueAsPerCent property changes
OnValueChanged Occurs when the value of the Value property changes
OnWidthChanged Occurs when the value of the Width property changes
⚠️ **GitHub.com Fallback** ⚠️