FoodCandy!

ProgressBar Class Reference

Represents a control which can display the progress of a process on the client-side. More...

List of all members.


Public Member Functions

 ProgressBar ()
 Initializes a new instance of the Wilco::Web::UI::WebControls::ProgressBar class.
void SetStarterControl (WebControl starterControl)
 Sets the starter control. If the control is clicked, the progress checker will start.
void RaiseCallbackEvent (string eventArgument)
 Executes the logic for the current callback.
string GetCallbackResult ()
 Gets the callback result.

Protected Member Functions

override void CreateChildControls ()
 Notifies server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
override void OnInit (EventArgs e)
 Raises the System::Web::UI::Control::Init event.
override void OnPreRender (EventArgs e)
 Raises the System::Web::UI::Control::PreRender event.
void UpdateProgress ()
 Ensures that the width of the progress bar is up to date.

Properties

bool AutoStart
 Gets whether the progress bar automatically starts when the page is loaded.
Style BarStyle
 Gets the bar style.
override ControlCollection Controls
 Gets the empty control collection, which prevents a user from adding child controls.
string JobID
 Gets or sets the job ID.
int Maximum
 Gets or sets the maximum progress value. If this value is set, the progres equals 100%.
int Minimum
 Gets or sets the minimum progress value. If this value is set, the progres equals 0%.
string ProcessStarter
 Gets or sets the control which starts the process.
IProgressProvider ProgressProvider
 Gets the progress provider.
int RefreshInterval
 Gets or sets the refresh interval.
bool StartOnSubmit
 Gets whether the progress bar should starts when the page is submitted.
int Value
 Gets or sets the position within the range of the progress bar. The default is 0.

Detailed Description

Represents a control which can display the progress of a process on the client-side.


Member Function Documentation

string GetCallbackResult  ) 
 

Gets the callback result.

Returns:

override void OnInit EventArgs  e  )  [protected]
 

Raises the System::Web::UI::Control::Init event.

Parameters:
e 

override void OnPreRender EventArgs  e  )  [protected]
 

Raises the System::Web::UI::Control::PreRender event.

Parameters:
e 

void RaiseCallbackEvent string  eventArgument  ) 
 

Executes the logic for the current callback.

Parameters:
eventArgument 

void SetStarterControl WebControl  starterControl  ) 
 

Sets the starter control. If the control is clicked, the progress checker will start.

Parameters:
starterControl 

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