Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

StatusBarProgressBarPanel Class

Namespace:
ActiproSoftware.UI.WinForms.Controls.Bars
Assembly:
ActiproSoftware.Bars.WinForms.dll

Represents a progressbar panel for a StatusBar.

public class StatusBarProgressBarPanel : StatusBarPanel, IInputElement, IUIElement, ILogicalTreeNode, IDisposable
Inheritance:
Object MarshalByRefObject DisposableObject LogicalTreeNodeBase UIElement StatusBarPanel Object
Implements:
IInputElement IUIElement ILogicalTreeNode IDisposable

Constructors

StatusBarProgressBarPanel()

Initializes a new instance of the StatusBarProgressBarPanel class.

public StatusBarProgressBarPanel()

Remarks

The default constructor initializes all fields to their default values.

Properties

Maximum

Gets or sets the upper bound of the range that is defined for this progress bar.

public int Maximum { get; set; }

Property Value

Int32:

The upper bound of the range that is defined for this progress bar. The default is 100.

Minimum

Gets or sets the lower bound of the range that is defined for this progress bar.

public int Minimum { get; set; }

Property Value

Int32:

The lower bound of the range that is defined for this progress bar. The default is 0.

Step

Gets or sets the amount by which a call to the PerformStep() method increases the current position of the progress bar.

public int Step { get; set; }

Property Value

Int32:

The amount by which to increment the progress bar with each call to the PerformStep() method. The default is 10.

Style

Gets or sets the StatusBarProgressBarPanelStyle that indicates how the progress bar should indicate status.

public StatusBarProgressBarPanelStyle Style { get; set; }

Property Value

StatusBarProgressBarPanelStyle:

The StatusBarProgressBarPanelStyle that indicates how the progress bar should indicate status.

Text

Gets or sets the text to display in the panel.

public string Text { get; set; }

Property Value

String:

The text to display in the panel.

TextTrimming

Gets or sets the StringTrimming to use for text in the panel.

public StringTrimming TextTrimming { get; set; }

Property Value

StringTrimming:

The StringTrimming to use for text in the panel.

Value

Gets or sets the current value of this progress bar.

public int Value { get; set; }

Property Value

Int32:

The current value of this progress bar.

Methods

Dispose(Boolean)

Disposes any resources used by the object.

protected override void Dispose(bool disposing)
Parameter Type Description
disposing Boolean

Whether the object is being disposed.

Increment(Int32)

Advances the current Value of the progress bar by the specified amount.

public void Increment(int value)
Parameter Type Description
value Int32

The amount by which to increment the progress bar's current Value.

MeasureOverride(Graphics, Size)

Measures the size in layout required for child elements and determines a size for the element itself.

protected override Size MeasureOverride(Graphics g, Size availableSize)
Parameter Type Description
g Graphics

The Graphics object to use for measurement.
availableSize Size

The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

Remarks

Element authors should override this method, call Measure on each visible child element and determine the total size required.

OnRender(PaintEventArgs)

Renders the element.

protected override void OnRender(PaintEventArgs e)
Parameter Type Description
e PaintEventArgs

A PaintEventArgs that contains the event data.

PerformStep()

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

public void PerformStep()

ResetPadding()

Resets the Padding property to its default value.

public override void ResetPadding()

ShouldSerializePadding()

Indicates whether the Padding property should be persisted.

public override bool ShouldSerializePadding()

Returns

Boolean:

true if the property value has changed from its default; otherwise, false.

Inherited Members