OpenPetra
Free Administration Software for Non-Profits
Public Member Functions | Properties | List of all members
Ict.Common.TProgressState Class Reference

current state of the long-running procedure More...

Public Member Functions

 TProgressState ()
 constructor More...
 

Properties

int PercentageDone [get, set]
 percentage done More...
 
decimal AbsoluteOverallAmount [get, set]
 overall amount More...
 
string StatusMessage [get, set]
 status message, which changes during the procedure More...
 
string Caption [get, set]
 caption, overall description of job More...
 
bool CancelJob [get, set]
 the client can ask the procedure to stop More...
 
bool JobFinished [get, set]
 if the job has finished, this is set to true. note: sometimes percentage might be inaccurate, or not present at all More...
 

Detailed Description

current state of the long-running procedure

Constructor & Destructor Documentation

◆ TProgressState()

Ict.Common.TProgressState.TProgressState ( )
inline

constructor

Property Documentation

◆ AbsoluteOverallAmount

decimal Ict.Common.TProgressState.AbsoluteOverallAmount
getset

overall amount

◆ CancelJob

bool Ict.Common.TProgressState.CancelJob
getset

the client can ask the procedure to stop

◆ Caption

string Ict.Common.TProgressState.Caption
getset

caption, overall description of job

◆ JobFinished

bool Ict.Common.TProgressState.JobFinished
getset

if the job has finished, this is set to true. note: sometimes percentage might be inaccurate, or not present at all

◆ PercentageDone

int Ict.Common.TProgressState.PercentageDone
getset

percentage done

◆ StatusMessage

string Ict.Common.TProgressState.StatusMessage
getset

status message, which changes during the procedure

The documentation for this class was generated from the following file: