PerformStep Method

ProgressBarMessager PerformStep Method

CleanCode C# Libraries v1.2.03 API

Performs a step, showing progress of a lengthy operation.

Namespace: CleanCode.GeneralComponents.Controls
Assembly: CleanCode.GeneralComponents (in CleanCode.GeneralComponents.dll) Version: 1.2.3.0 (1.2.03)

Syntax

C++

Copy to Clipboard Print

public void PerformStep(
	string statusMessage
)

public void PerformStep(
	string statusMessage
)

Public Sub PerformStep ( _
	statusMessage As String _
)

Public Sub PerformStep ( _
	statusMessage As String _
)

public:
void PerformStep(
	String^ statusMessage
)

public:
void PerformStep(
	String^ statusMessage
)

Parameters

statusMessage: Type: System String
The status message.

Remarks

From the eponymous method of the Online

ProgressBar, the "step" here involves several actions: (a) marking the previous step completed (changing its icon from a current arrow to a check mark); (b) advancing the child ProgressBar; (c) and showing a new current step. To record that the final step is complete, invoke PerformStep(String) with a null argument; this will perform only the (a) action, omitting (b) and (c).