ProgressMonitor Class Documentation
classProgressMonitor : SystemIDisposableNamespace:Datalogics::PDFL
- Inherits from:
SystemIDisposable
Detailed Description
Represents the progress of an operation.
The class can display a dialog if a process will take time, and the Progress method can indicate how long the process will last.
Referenced by
Uses types
Constructor & Destructor Documentation
ProgressMonitor
ProgressMonitor(ProgressMonitorrhs, InternalConstructsignifier)Parameters
rhs: ProgressMonitorsignifier: InternalConstruct
ProgressMonitor
ProgressMonitor()~ProgressMonitor
~ProgressMonitor()Member Function Documentation
BeginOperation
voidBeginOperation()Returns:
voidInitializes the progress monitor and displays it with a current value of zero. This method will be called first when the progress monitor is used.
ConstructorRetrieve
static ProgressMonitorConstructorRetrieve(System.IntPtrignored)Parameters
ignored: System.IntPtr
Returns:
ProgressMonitorDispose
voidDispose()Returns:
voidDisposeChildren
voidDisposeChildren()Returns:
voidEndOperation
voidEndOperation()Returns:
voidDraws the progress monitor with its current value set to the progress monitor's duration (a full progress monitor), then removes the progress monitor from the display.
GetCurrentValue
intGetCurrentValue()Returns:
intThe current value of the progress monitor. The allowed value ranges from 0 (empty) to the value passed to SetDuration.
For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.
GetDuration
intGetDuration()Returns:
intThe progress monitor's duration.
SetCurrentValue
voidSetCurrentValue(intcurrentValue)Parameters
currentValue: intThe progress monitor's current value.
Returns:
voidSets the current value of the progress monitor and updates the display. The allowed value ranges from 0 (empty) to the value passed to SetDuration.
For example, if the progress monitor's duration is 10, the current value must be between 0 and 10, inclusive.
SetDuration
voidSetDuration(intduration)Parameters
duration: intThe maximum value the progress monitor will be allowed to have.
Returns:
voidSets the value that corresponds to a full progress monitor display. The progress monitor is subsequently filled in by setting its current value. This method will be called before setting the progress monitor's current value.
SetText
voidSetText(stringtext)Parameters
text: string
Returns:
voidDisplay a UTF-8 text string in the progress monitor.