2.2.0.2 - Reintroduced the thread for saving screenshots and the lock on xDoc

Author: igloo-gkendall

FormMain.cs

@@ -46,6 +46,8 @@ public partial class FormMain : Form
 
         private BackgroundWorker runFilterSearchThread = null;
 
+        private BackgroundWorker runSaveScreenshotsThread = null;
+
         /// <summary>
         /// Delegates for the threads.
         /// </summary>
@@ -172,6 +174,13 @@ private void InitializeThreads()
                 WorkerSupportsCancellation = true
             };
             runFilterSearchThread.DoWork += new DoWorkEventHandler(DoWork_runFilterSearchThread);
+
+            runSaveScreenshotsThread = new BackgroundWorker
+            {
+                WorkerReportsProgress = false,
+                WorkerSupportsCancellation = true
+            };
+            runSaveScreenshotsThread.DoWork += new DoWorkEventHandler(DoWork_runSaveScreenshotsThread);
         }
 
         /// <summary>
@@ -425,6 +434,14 @@ private void DeleteSlides()
             }
         }
 
+        private void SaveScreenshots()
+        {
+            if (runSaveScreenshotsThread != null && !runSaveScreenshotsThread.IsBusy)
+            {
+                runSaveScreenshotsThread.RunWorkerAsync();
+            }
+        }
+
         /// <summary>
         /// Searches for screenshots.
         /// </summary>
@@ -528,6 +545,11 @@ private void RunDeleteSlides(DoWorkEventArgs e)
             FileSystem.DeleteFilesInDirectory(FileSystem.SlidesFolder);
         }
 
+        private void RunSaveScreenshots(DoWorkEventArgs e)
+        {
+            _screenshotCollection.Save();
+        }
+
         private void RunFilterSearch(DoWorkEventArgs e)
         {
             if (comboBoxFilterValue.InvokeRequired)
@@ -715,7 +737,7 @@ private void StopScreenCapture()
                     SearchFilterValues();
                     SearchDates();
 
-                    _screenshotCollection.Save();
+                    SaveScreenshots();
 
                     Log.Write("Running triggers of condition type ScreenCaptureStopped");
                     RunTriggersOfConditionType(TriggerConditionType.ScreenCaptureStopped);
@@ -1063,6 +1085,11 @@ private void DoWork_runDeleteSlidesThread(object sender, DoWorkEventArgs e)
             RunDeleteSlides(e);
         }
 
+        private void DoWork_runSaveScreenshotsThread(object sender, DoWorkEventArgs e)
+        {
+            RunSaveScreenshots(e);
+        }
+
         /// <summary>
         /// Runs the "delete old screenshots" thread.
         /// </summary>
@@ -2927,7 +2954,7 @@ private void comboBoxFilterType_SelectedIndexChanged(object sender, EventArgs e)
         /// <param name="e"></param>
         private void timerSaveScreenshots_Tick(object sender, EventArgs e)
         {
-            _screenshotCollection.Save();
+            SaveScreenshots();
         }
     }
 }

screenshots/ScreenshotCollection.cs

@@ -561,67 +561,70 @@ public void Save()
 
                     if (!screenshot.Saved && xDoc != null && screenshot?.Format != null && !string.IsNullOrEmpty(screenshot.Format.Name))
                     {
-                        XmlElement xScreenshot = xDoc.CreateElement(XML_FILE_SCREENSHOT_NODE);
+                        lock (xDoc)
+                        {
+                            XmlElement xScreenshot = xDoc.CreateElement(XML_FILE_SCREENSHOT_NODE);
 
-                        XmlElement xViedId = xDoc.CreateElement(SCREENSHOT_VIEWID);
-                        xViedId.InnerText = screenshot.ViewId.ToString();
+                            XmlElement xViedId = xDoc.CreateElement(SCREENSHOT_VIEWID);
+                            xViedId.InnerText = screenshot.ViewId.ToString();
 
-                        XmlElement xDate = xDoc.CreateElement(SCREENSHOT_DATE);
-                        xDate.InnerText = screenshot.Date;
+                            XmlElement xDate = xDoc.CreateElement(SCREENSHOT_DATE);
+                            xDate.InnerText = screenshot.Date;
 
-                        XmlElement xTime = xDoc.CreateElement(SCREENSHOT_TIME);
-                        xTime.InnerText = screenshot.Time;
+                            XmlElement xTime = xDoc.CreateElement(SCREENSHOT_TIME);
+                            xTime.InnerText = screenshot.Time;
 
-                        XmlElement xPath = xDoc.CreateElement(SCREENSHOT_PATH);
-                        xPath.InnerText = screenshot.Path;
+                            XmlElement xPath = xDoc.CreateElement(SCREENSHOT_PATH);
+                            xPath.InnerText = screenshot.Path;
 
-                        XmlElement xFormat = xDoc.CreateElement(SCREENSHOT_FORMAT);
-                        xFormat.InnerText = screenshot.Format.Name;
+                            XmlElement xFormat = xDoc.CreateElement(SCREENSHOT_FORMAT);
+                            xFormat.InnerText = screenshot.Format.Name;
 
-                        XmlElement xComponent = xDoc.CreateElement(SCREENSHOT_COMPONENT);
-                        xComponent.InnerText = screenshot.Component.ToString();
+                            XmlElement xComponent = xDoc.CreateElement(SCREENSHOT_COMPONENT);
+                            xComponent.InnerText = screenshot.Component.ToString();
 
-                        XmlElement xSlidename = xDoc.CreateElement(SCREENSHOT_SLIDENAME);
-                        xSlidename.InnerText = screenshot.Slide.Name;
+                            XmlElement xSlidename = xDoc.CreateElement(SCREENSHOT_SLIDENAME);
+                            xSlidename.InnerText = screenshot.Slide.Name;
 
-                        XmlElement xSlidevalue = xDoc.CreateElement(SCREENSHOT_SLIDEVALUE);
-                        xSlidevalue.InnerText = screenshot.Slide.Value;
+                            XmlElement xSlidevalue = xDoc.CreateElement(SCREENSHOT_SLIDEVALUE);
+                            xSlidevalue.InnerText = screenshot.Slide.Value;
 
-                        XmlElement xWindowTitle = xDoc.CreateElement(SCREENSHOT_WINDOW_TITLE);
-                        xWindowTitle.InnerText = screenshot.WindowTitle;
+                            XmlElement xWindowTitle = xDoc.CreateElement(SCREENSHOT_WINDOW_TITLE);
+                            xWindowTitle.InnerText = screenshot.WindowTitle;
 
-                        XmlElement xLabel = xDoc.CreateElement(SCREENSHOT_LABEL);
-                        xLabel.InnerText = screenshot.Label;
+                            XmlElement xLabel = xDoc.CreateElement(SCREENSHOT_LABEL);
+                            xLabel.InnerText = screenshot.Label;
 
-                        xScreenshot.AppendChild(xViedId);
-                        xScreenshot.AppendChild(xDate);
-                        xScreenshot.AppendChild(xTime);
-                        xScreenshot.AppendChild(xPath);
-                        xScreenshot.AppendChild(xFormat);
-                        xScreenshot.AppendChild(xComponent);
-                        xScreenshot.AppendChild(xSlidename);
-                        xScreenshot.AppendChild(xSlidevalue);
-                        xScreenshot.AppendChild(xWindowTitle);
-                        xScreenshot.AppendChild(xLabel);
+                            xScreenshot.AppendChild(xViedId);
+                            xScreenshot.AppendChild(xDate);
+                            xScreenshot.AppendChild(xTime);
+                            xScreenshot.AppendChild(xPath);
+                            xScreenshot.AppendChild(xFormat);
+                            xScreenshot.AppendChild(xComponent);
+                            xScreenshot.AppendChild(xSlidename);
+                            xScreenshot.AppendChild(xSlidevalue);
+                            xScreenshot.AppendChild(xWindowTitle);
+                            xScreenshot.AppendChild(xLabel);
 
-                        XmlNode xScreenshots = xDoc.SelectSingleNode(SCREENSHOTS_XPATH);
+                            XmlNode xScreenshots = xDoc.SelectSingleNode(SCREENSHOTS_XPATH);
 
-                        if (xScreenshots != null)
-                        {
-                            if (xScreenshots.HasChildNodes)
-                            {
-                                xScreenshots.InsertAfter(xScreenshot, xScreenshots.LastChild);
-                            }
-                            else
+                            if (xScreenshots != null)
                             {
-                                xScreenshots.AppendChild(xScreenshot);
-                            }
+                                if (xScreenshots.HasChildNodes)
+                                {
+                                    xScreenshots.InsertAfter(xScreenshot, xScreenshots.LastChild);
+                                }
+                                else
+                                {
+                                    xScreenshots.AppendChild(xScreenshot);
+                                }
 
-                            xDoc.Save(FileSystem.ApplicationFolder + FileSystem.ScreenshotsFile);
+                                xDoc.Save(FileSystem.ApplicationFolder + FileSystem.ScreenshotsFile);
 
-                            screenshot.Saved = true;
+                                screenshot.Saved = true;
 
-                            _screenshotList[i] = screenshot;
+                                _screenshotList[i] = screenshot;
+                            }
                         }
                     }
                 }