/// <summary>
/// Executes in two distinct scenarios.
///
/// 1. If disposing is true, the method has been called directly
/// or indirectly by a user's code via the Dispose method.
/// Both managed and unmanaged resources can be disposed.
///
/// 2. If disposing is false, the method has been called by the
/// runtime from inside the finalizer and you should not reference (access)
/// other managed objects, as they already have been garbage collected.
/// Only unmanaged resources can be disposed.
/// </summary>
/// <param name="disposing"></param>
/// <remarks>
/// If any exceptions are thrown, that is fine.
/// If the method is being done in a finalizer, it will be ignored.
/// If it is thrown by client code calling Dispose,
/// it needs to be handled by fixing the bug.
///
/// If subclasses override this method, they should call the base implementation.
/// </remarks>
protected virtual void Dispose(bool disposing)
{
System.Diagnostics.Debug.WriteLineIf(!disposing, "****** Missing Dispose() call for " + GetType().Name + ". ****** ");
// Must not be run more than once.
if (m_isDisposed)
{
return;
}
if (disposing)
{
// Dispose managed resources here.
if (m_progressBar != null)
{
m_progressBar.ClearStateProvider();
//m_progressBar.Dispose(); // We don't own this!! (JohnT)
}
if (m_wait != null)
{
m_wait.Dispose();
m_wait = null;
}
}
// Dispose unmanaged resources here, whether disposing is true or false.
m_progressBar = null;
m_status = null;
m_isDisposed = true;
}
/// <summary>
///
/// </summary>
/// <param name="progressBar"></param>
public ProgressState(IProgressDisplayer progressBar)
{
System.Windows.Forms.Cursor.Current = System.Windows.Forms.Cursors.WaitCursor;
m_percentDone = 0;
m_progressBar = progressBar;
if (m_progressBar != null)
m_progressBar.SetStateProvider(this);
}
/// <summary/>
public ProgressState(IProgressDisplayer progressBar)
{
m_wait = new WaitCursor(Form.ActiveForm);
m_percentDone = 0;
m_progressBar = progressBar;
if (m_progressBar != null)
m_progressBar.SetStateProvider(this);
}
/// <summary>
///
/// </summary>
/// <param name="progressBar"></param>
public ProgressState(IProgressDisplayer progressBar)
{
System.Windows.Forms.Cursor.Current = System.Windows.Forms.Cursors.WaitCursor;
m_percentDone = 0;
m_progressBar = progressBar;
if (m_progressBar != null)
{
m_progressBar.SetStateProvider(this);
}
}
/// <summary/>
public ProgressState(IProgressDisplayer progressBar)
{
m_wait = new WaitCursor(Form.ActiveForm);
m_percentDone = 0;
m_progressBar = progressBar;
if (m_progressBar != null)
{
m_progressBar.SetStateProvider(this);
}
}
/// <summary>
/// This progress state just knows enough to divide the task into a set of milestones
/// </summary>
public MilestoneProgressState(IProgressDisplayer progressBar):base(progressBar)
{
}
/// <summary>
/// Executes in two distinct scenarios.
///
/// 1. If disposing is true, the method has been called directly
/// or indirectly by a user's code via the Dispose method.
/// Both managed and unmanaged resources can be disposed.
///
/// 2. If disposing is false, the method has been called by the
/// runtime from inside the finalizer and you should not reference (access)
/// other managed objects, as they already have been garbage collected.
/// Only unmanaged resources can be disposed.
/// </summary>
/// <param name="disposing"></param>
/// <remarks>
/// If any exceptions are thrown, that is fine.
/// If the method is being done in a finalizer, it will be ignored.
/// If it is thrown by client code calling Dispose,
/// it needs to be handled by fixing the bug.
///
/// If subclasses override this method, they should call the base implementation.
/// </remarks>
protected virtual void Dispose(bool disposing)
{
System.Diagnostics.Debug.WriteLineIf(!disposing, "****** Missing Dispose() call for " + GetType().Name + ". ****** ");
// Must not be run more than once.
if (m_isDisposed)
return;
if (disposing)
{
// Dispose managed resources here.
if (m_progressBar != null)
{
m_progressBar.ClearStateProvider();
//m_progressBar.Dispose(); // We don't own this!! (JohnT)
}
if (m_wait != null)
{
m_wait.Dispose();
m_wait = null;
}
}
// Dispose unmanaged resources here, whether disposing is true or false.
m_progressBar = null;
m_status = null;
m_isDisposed = true;
}
/// <summary>
/// This progress state just knows enough to divide the task into a set of milestones
/// </summary>
public MilestoneProgressState(IProgressDisplayer progressBar) : base(progressBar)
{
}
