ProgressMonitor Class Documentation

class ProgressMonitor : SystemIDisposable

Namespace: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

DocumentPDFOptimizerSignDoc

Constructor & Destructor Documentation

ProgressMonitor

ProgressMonitor()

Creates a new ProgressMonitor with duration and current value initialized to zero.

Member Function Documentation

BeginOperation

void BeginOperation()

Returns:

void

Initializes the progress monitor and displays it with a current value of zero. This method will be called first when the progress monitor is used.

Dispose

void Dispose()

Returns:

void

EndOperation

void EndOperation()

Returns:

void

Draws 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

int GetCurrentValue()

Returns:

int

The progress monitor's current value.

Gets the 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

int GetDuration()

Returns:

int

The maximum value the progress monitor is allowed to have, as set by SetDuration.

Gets the progress monitor's duration.

SetCurrentValue

void SetCurrentValue(int currentValue)

Parameters

currentValue: int

The progress monitor's current value.

Returns:

void

Sets 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

void SetDuration(int duration)

Parameters

duration: int

The maximum value the progress monitor will be allowed to have.

Returns:

void

Sets 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

void SetText(string text)

Parameters

text: string

The UTF-8 encoded text string to display.

Returns:

void

Display a UTF-8 text string in the progress monitor.