• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • ICredentialsStore
    • IEnvironment
    • IForwardState
    • IHttpHeaders
    • IParameters
    • ISessionVariables
    • ISystemSettings
    • Plugin
  • Softadmin.Api.Database
    • IDbRequest
    • IDbRequestFactory
  • Softadmin.Api.Diagnostics
    • ILogger
  • Softadmin.Api.Login
    • IUserState
    • LoginPlugin
    • PostLoginPlugin
    • PreLoginPlugin
    • UserAuthenticationPlugin
  • Softadmin.Api.Logout
    • LogoutPlugin
  • Softadmin.Api.Page
    • ICustomPage
    • PagePlugin
  • Softadmin.Api.Ui
    • IDebugWindow
    • IProgressWindow

Interface IProgressWindow

A progress bar displayed in the GUI.

Namespace: Softadmin.Api.Ui
Assembly: Softadmin.Api.dll
Syntax
public interface IProgressWindow

Methods

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.

In This Article
Back to top Generated by DocFX