FoodCandy!

IProgressProvider Interface Reference

Provides an interface for progress providers. More...

Inheritance diagram for IProgressProvider:

ProgressProvider List of all members.

Public Member Functions

void Initialize (HttpContext context, ProgressBar bar)
 Initializes the provider.
string CreateJobID ()
 Creates a new job ID.
void RemoveJobID (string jobID)
 Removes a job ID.
double GetProgress (string jobID)
 Gets the progress of the progress bar.
void SetProgress (string jobID, double value)
 Sets the progress of the progress bar.

Detailed Description

Provides an interface for progress providers.


Member Function Documentation

string CreateJobID  ) 
 

Creates a new job ID.

Returns:

Implemented in ProgressProvider.

double GetProgress string  jobID  ) 
 

Gets the progress of the progress bar.

Parameters:
jobID The ID of the job.
Returns:
The progress the job has made.

Implemented in ProgressProvider.

void Initialize HttpContext  context,
ProgressBar  bar
 

Initializes the provider.

Parameters:
context 
bar 

Implemented in ProgressProvider.

void RemoveJobID string  jobID  ) 
 

Removes a job ID.

Parameters:
jobID 

Implemented in ProgressProvider.

void SetProgress string  jobID,
double  value
 

Sets the progress of the progress bar.

Parameters:
jobID The ID of the job.
value The progress the job has made.

Implemented in ProgressProvider.


The documentation for this interface was generated from the following file:
  • IProgressProvider.cs
© FoodCandy, 2006-2007, All Rights Reserved | FoodCandy | Sun Oct 7 10:48:54 2007 | Doxygen 1.4.6-NO