BioImager.Progress Class Reference

Inheritance diagram for BioImager.Progress:

Public Member Functions
	Progress (string file, string status)
void	UpdateProgress (int p)
void	UpdateProgressF (float p)

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used.

Properties
string	Status [get, set]
float	ProgressValue [get, set]

Detailed Description

Definition at line 3 of file Progress.Designer.cs.

Constructor & Destructor Documentation

Progress()

BioImager.Progress.Progress	(	string	file,
		string	status )

Definition at line 17 of file Progress.cs.

        {
            InitializeComponent();
            watch.Start();
            statusLabel.Text = status;
            fileLabel.Text = file;
            timer.Start();
        }

Member Function Documentation

Dispose()

override void BioImager.Progress.Dispose ( bool disposing )

protected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

Definition at line 14 of file Progress.Designer.cs.

        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

UpdateProgress()

void BioImager.Progress.UpdateProgress

(

int

p

)

Definition at line 65 of file Progress.cs.

        {
            progressBar.Value = p;
        }

UpdateProgressF()

void BioImager.Progress.UpdateProgressF

(

float

p

)

Definition at line 69 of file Progress.cs.

        {
            if (p * 100 > progressBar.Maximum)
                return;
            progressBar.Value = (int)(p * 100);
        }

Property Documentation

ProgressValue

float BioImager.Progress.ProgressValue

getset

Definition at line 43 of file Progress.cs.

        {
            get { return progressBar.Value; }
            set 
            {
                if (progressBar.InvokeRequired)
                {
                    if (progressBar.Maximum < value)
                    {
                        progressBar.Invoke(() => progressBar.Value = (int)(value / 100));
                    }
                    else
                        progressBar.Invoke(() => progressBar.Value = (int)value);
                    return;
                }
                if (progressBar.Maximum < value)
                    progressBar.Value = (int)(value * 100);
                else
                    progressBar.Value = (int)(value);
            }
        }

Status

string BioImager.Progress.Status

getset

Definition at line 26 of file Progress.cs.

        {
            get { return statusLabel.Text; }
            set 
            {
                // Use Invoke to update the label on the UI thread
                if (statusLabel.InvokeRequired)
                {
                    statusLabel.Invoke(() => statusLabel.Text = value);
                }
                else
                {
                    statusLabel.Text = value;
                }
            }
        }

---

The documentation for this class was generated from the following files:

• BioImager/Source/Progress.cs
• BioImager/Source/Progress.Designer.cs