C# Class BF2Statistics.TaskProgressUpdate

This class is used to post updated progress to the TaskForm, allowing the form's progressbar and text fields to be changed as progress updates.

Show file Open project: BF2Statistics/ControlCenter Class Usage Examples

Public Properties

Property	Type	Description
HeaderText	string
IncrementProgress	bool
MessageText	string
ProgressPercent	int
WindowTitle	string

Public Methods

Method	Description
TaskProgressUpdate ( ) : System	Creates a new instance of TaskProgressUpdate
TaskProgressUpdate ( int ProgressPercent, bool IncrementPercent = false ) : System	Creates a new instance of TaskProgressUpdate
TaskProgressUpdate ( string MessageText ) : System	Creates a new instance of TaskProgressUpdate
TaskProgressUpdate ( string MessageText, int ProgressPercent, bool IncrementPercent = false ) : System	Creates a new instance of TaskProgressUpdate
TaskProgressUpdate ( string MessageText, string HeaderText ) : System	Creates a new instance of TaskProgressUpdate
TaskProgressUpdate ( string MessageText, string HeaderText, int ProgressPercent, bool IncrementPercent = false ) : System	Creates a new instance of TaskProgressUpdate

Method Details

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( ) : System
return	System

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( int ProgressPercent, bool IncrementPercent = false ) : System
ProgressPercent	int	Sets the progress percentage of the TaskForm's progress bar
IncrementPercent	bool	/// If set to true, then is Incremented onto the progressbar's current percentage ///
return	System

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( string MessageText ) : System
MessageText	string	Sets the content status message of the TaskForm
return	System

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( string MessageText, int ProgressPercent, bool IncrementPercent = false ) : System
MessageText	string	Sets the content status message of the TaskForm
ProgressPercent	int	Sets the progress percentage of the TaskForm's progress bar
IncrementPercent	bool	/// If set to true, then is Incremented onto the progressbar's current percentage ///
return	System

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( string MessageText, string HeaderText ) : System
MessageText	string	Sets the content status message of the TaskForm
HeaderText	string	Sets the Instruction (header) text of the TaskForm
return	System

TaskProgressUpdate() public method

Creates a new instance of TaskProgressUpdate

public TaskProgressUpdate ( string MessageText, string HeaderText, int ProgressPercent, bool IncrementPercent = false ) : System
MessageText	string	Sets the content status message of the TaskForm
HeaderText	string	Sets the Instruction (header) text of the TaskForm
ProgressPercent	int	Sets the progress percentage of the TaskForm's progress bar
IncrementPercent	bool	/// If set to true, then is Incremented onto the progressbar's current percentage ///
return	System

Property Details

HeaderText public property

Sets the Instruction Text of the TaskForm

public string HeaderText
return	string

IncrementProgress public property

Gets or Sets whether the progress bar is set, or incremented from its current value

public bool IncrementProgress
return	bool

MessageText public property

Sets the Content Message Text of the TaskForm

public string MessageText
return	string

ProgressPercent public property

Sets the Progress Bar Percentage of the TaskForm

public int ProgressPercent
return	int

WindowTitle public property

Sets the Window Title of the TaskForm

public string WindowTitle
return	string