Interface IProgressWindow
A progress bar displayed in the GUI.
Namespace: Softadmin.Api.Ui
Assembly: Softadmin.Api.dll
Syntax
public interface IProgressWindowMethods
SetIndeterminateProgress(String, String)
Sets the progress to indeterminate.
Declaration
void SetIndeterminateProgress(string title, string message = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | title | The operation currently being performed. |
| System.String | message | Additional progress information. |
Remarks
Use when the application is performing a slow operation of unknown scope.
SetProgress(Single, String, String)
Sets the state of the progress bar.
Declaration
void SetProgress(float progress, string title = null, string message = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | progress | A number between 0.0 and 1.0. |
| System.String | title | The operation currently being performed. |
| System.String | message | Additional progress information. |
Remarks
Use when the application is performing a slow operation of known scope.
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException |
|