Changeset 15477 for branches/EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs

Timestamp:

11/16/17 10:30:21 (7 years ago)

Author:

pfleck

Message:

#2845

• Added an explicit method for StartMarquee.
• Renamed Add/RemoveOperationProgress methods.
• Moved progress helpers from MainForm into static Progress methods named Show and Hide.

File:

• branches/EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs (modified) (2 diffs)

branches/EnhancedProgress/HeuristicLab.MainForm/3.3/Interfaces/IProgress.cs

@@ -35 +35 @@
     /// Changing the ProgressValue when ProgressBarMode is Marquee raises an Exception.
     /// </summary>
+    /// <exception cref="InvalidOperationException">Setting the ProgressValue-property while in the Marquee state is invalid.</exception>
     double ProgressValue { get; set; }
     bool CanBeStopped { get; }
@@ -40 +41 @@
 
     /// <summary>
-    /// Start (or Restart) a progress with ProgressBarMode Marquee
+    /// Start (or Restart) a progress in ProgressBarMode Continues to display specific progress values (from 0 to 1).
+    /// A new progress value is reported by setting the ProgressValue-property.
     /// </summary>
-    void Start(string message);
+    void Start(string message, double progressValue = 0);
+
     /// <summary>
-    /// Start (or Restart) a progress with ProgressBarMode Continues
+    /// Start (or Restart) a progress in ProgressBarMode Marquee to define an "unknown" progress state.
+    /// Consider using marquee when the progress is not measurable but the user should be notified that something is still happening.
+    /// Setting the ProgressValue-property in the Marquee state throws an exception.
     /// </summary>
-    void Start(string message, double progressValue);
+    void StartMarquee(string message);
+
     void Finish();
     void Stop();