C# Class BF2Statistics.TaskForm

Inheritance: System.Windows.Forms.Form
Afficher le fichier Open project: BF2Statistics/ControlCenter Class Usage Examples

Méthodes publiques

Свойство Type Description
Progress IProgress

Protected Properties

Свойство Type Description
Cancelable bool

Méthodes publiques

Méthode Description
CloseForm ( ) : void

Closes the Task dialog, and clears the Cancelled event handle subscriptions

Show ( Form Parent, string WindowTitle, string InstructionText, ProgressBarStyle Style, int Steps ) : void

Open and displays the task form.

Show ( Form Parent, string WindowTitle, string InstructionText, bool Cancelable ) : void

Open and displays the task form.

Show ( Form Parent, string WindowTitle, string InstructionText, bool Cancelable, ProgressBarStyle Style, int Steps ) : void

Open and displays the task form.

Show ( Form Parent, string WindowTitle, string InstructionText, string SubMessage, bool Cancelable, ProgressBarStyle Style, int ProgressBarSteps ) : void

Open and displays the task form.

Méthodes protégées

Méthode Description
Dispose ( bool disposing ) : void

Clean up any resources being used.

Private Methods

Méthode Description
CancelBtn_Click ( object sender, EventArgs e ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.

ProgressChanged ( TaskProgressUpdate e ) : void

Updates the TaskForm controls after a Progress.Report() has been recieved

TaskForm ( ) : System

Private constructor... Use the Show() method rather

TaskForm_FormClosed ( object sender, System.Windows.Forms.FormClosedEventArgs e ) : void

Method Details

CloseForm() public static méthode

Closes the Task dialog, and clears the Cancelled event handle subscriptions
public static CloseForm ( ) : void
Résultat void

Dispose() protected méthode

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
Résultat void

Show() public static méthode

Open and displays the task form.
Thrown if the Task form is already open and running. Use the IsOpen property /// to determine if the form is already running
public static Show ( Form Parent, string WindowTitle, string InstructionText, ProgressBarStyle Style, int Steps ) : void
Parent System.Windows.Forms.Form The calling form, so the task form can be centered
WindowTitle string The task dialog window title
InstructionText string Instruction text displayed after the info icon. Leave null /// to hide the instruction text and icon.
Style ProgressBarStyle The progress bar style
Steps int
Résultat void

Show() public static méthode

Open and displays the task form.
Thrown if the Task form is already open and running. Use the IsOpen property /// to determine if the form is already running
public static Show ( Form Parent, string WindowTitle, string InstructionText, bool Cancelable ) : void
Parent System.Windows.Forms.Form The calling form, so the task form can be centered
WindowTitle string The task dialog window title
InstructionText string Instruction text displayed after the info icon. Leave null /// to hide the instruction text and icon.
Cancelable bool Specifies whether the operation can be canceled
Résultat void

Show() public static méthode

Open and displays the task form.
Thrown if the Task form is already open and running. Use the IsOpen property /// to determine if the form is already running
public static Show ( Form Parent, string WindowTitle, string InstructionText, bool Cancelable, ProgressBarStyle Style, int Steps ) : void
Parent System.Windows.Forms.Form The calling form, so the task form can be centered
WindowTitle string The task dialog window title
InstructionText string Instruction text displayed after the info icon. Leave null /// to hide the instruction text and icon.
Cancelable bool Specifies whether the operation can be canceled
Style ProgressBarStyle The progress bar style
Steps int
Résultat void

Show() public static méthode

Open and displays the task form.
Thrown if the Task form is already open and running. Use the IsOpen property /// to determine if the form is already running
public static Show ( Form Parent, string WindowTitle, string InstructionText, string SubMessage, bool Cancelable, ProgressBarStyle Style, int ProgressBarSteps ) : void
Parent System.Windows.Forms.Form The calling form, so the task form can be centered
WindowTitle string The task dialog window title
InstructionText string Instruction text displayed after the info icon. Leave null /// to hide the instruction text and icon.
SubMessage string Detail text that is displayed just above the progress bar
Cancelable bool Specifies whether the operation can be canceled
Style ProgressBarStyle The progress bar style
ProgressBarSteps int
Résultat void

Property Details

Cancelable protected_oe property

Gets or Sets whether the task is cancelable
protected bool Cancelable
Résultat bool

Progress public_oe static_oe property

A progress object that is used to report progress to the TaskForm and update the GUI
public static IProgress Progress
Résultat IProgress