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, IDpiAwareElement, IDisposable
Inheritance:
object MarshalByRefObject MarshalByRefDisposableObject LogicalTreeNodeBase UIElement StatusBarPanel object
Implements:
IInputElement IUIElement ILogicalTreeNode IDpiAwareElement IDisposable

Constructors

StatusBarProgressBarPanel()

Initializes an instance of the class.

public StatusBarProgressBarPanel()

Properties

Maximum

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

public int Maximum { get; set; }

Property Value

int:

The default is 100.

Minimum

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

public int Minimum { get; set; }

Property Value

int:

The default is 0.

Step

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

int:

The default is 10.

Style

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

public StatusBarProgressBarPanelStyle Style { get; set; }

Property Value

StatusBarProgressBarPanelStyle

Text

The text to display in the panel.

public string? Text { get; set; }

Property Value

string

TextTrimming

The StringTrimming to use for text in the panel.

public StringTrimming TextTrimming { get; set; }

Property Value

StringTrimming

Value

The current value of this progress bar.

public int Value { get; set; }

Property Value

int

Methods

Dispose(bool)

Releases the unmanaged resources used by the object and optionally releases the managed resources.

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

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

Increment(int)

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

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

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(Graphics?, Size) 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

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

bool:

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

Inherited Members

Extension Methods