2.4.1.9 - New macro tag "%capturenow%". Changelog and Help documentation updated. Code cleanup.

Author: gavinkendall

DataConvert.cs

@@ -28,7 +28,7 @@ namespace AutoScreenCapture
     public class DataConvert
     {
         /// <summary>
-        /// 
+        /// Constructor
         /// </summary>
         public DataConvert()
         {

Gavin.Kendall.SFTP/SftpClient.cs

@@ -30,11 +30,22 @@ public class SftpClient
     {
         private Renci.SshNet.SftpClient _sftpClient;
 
+        /// <summary>
+        /// An SFTP client to handle SFTP operations.
+        /// </summary>
+        /// <param name="host">The host.</param>
+        /// <param name="port">The port number.</param>
+        /// <param name="username">The username to use to connect to the host.</param>
+        /// <param name="password">The password to use to connect to the host.</param>
         public SftpClient(string host, int port, string username, string password)
         {
             _sftpClient = new Renci.SshNet.SftpClient(host, port, username, password);
         }
 
+        /// <summary>
+        /// Connects to the host.
+        /// </summary>
+        /// <returns>Returns true if connection was successful or false if connection was not successful.</returns>
         public bool Connect()
         {
             try

ScreenCapture.cs

@@ -83,9 +83,9 @@ public enum ScreenSavingErrorLevels
     /// </summary>
     public class ScreenCapture
     {
-        private Log _log;
-        private Config _config;
-        private FileSystem _fileSystem;
+        private readonly Log _log;
+        private readonly Config _config;
+        private readonly FileSystem _fileSystem;
 
         [StructLayout(LayoutKind.Sequential)]
         private struct CURSORINFO
@@ -200,37 +200,37 @@ private struct DEVMODE
             private const int CCHDEVICENAME = 0x20;
             private const int CCHFORMNAME = 0x20;
             [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 0x20)]
-            private string dmDeviceName;
-            private short dmSpecVersion;
-            private short dmDriverVersion;
+            private readonly string dmDeviceName;
+            private readonly short dmSpecVersion;
+            private readonly short dmDriverVersion;
             internal short dmSize;
-            private short dmDriverExtra;
-            private int dmFields;
-            private int dmPositionX;
-            private int dmPositionY;
-            private ScreenOrientation dmDisplayOrientation;
-            private int dmDisplayFixedOutput;
-            private short dmColor;
-            private short dmDuplex;
-            private short dmYResolution;
-            private short dmTTOption;
-            private short dmCollate;
+            private readonly short dmDriverExtra;
+            private readonly int dmFields;
+            private readonly int dmPositionX;
+            private readonly int dmPositionY;
+            private readonly ScreenOrientation dmDisplayOrientation;
+            private readonly int dmDisplayFixedOutput;
+            private readonly short dmColor;
+            private readonly short dmDuplex;
+            private readonly short dmYResolution;
+            private readonly short dmTTOption;
+            private readonly short dmCollate;
             [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 0x20)]
-            private string dmFormName;
-            private short dmLogPixels;
-            private int dmBitsPerPel;
-            internal int dmPelsWidth;
-            internal int dmPelsHeight;
-            private int dmDisplayFlags;
-            private int dmDisplayFrequency;
-            private int dmICMMethod;
-            private int dmICMIntent;
-            private int dmMediaType;
-            private int dmDitherType;
-            private int dmReserved1;
-            private int dmReserved2;
-            private int dmPanningWidth;
-            private int dmPanningHeight;
+            private readonly string dmFormName;
+            private readonly short dmLogPixels;
+            private readonly int dmBitsPerPel;
+            internal readonly int dmPelsWidth;
+            internal readonly int dmPelsHeight;
+            private readonly int dmDisplayFlags;
+            private readonly int dmDisplayFrequency;
+            private readonly int dmICMMethod;
+            private readonly int dmICMIntent;
+            private readonly int dmMediaType;
+            private readonly int dmDitherType;
+            private readonly int dmReserved1;
+            private readonly int dmReserved2;
+            private readonly int dmPanningWidth;
+            private readonly int dmPanningHeight;
         }
 
         private DEVMODE _dm;
@@ -281,7 +281,7 @@ public struct DeviceOptions
         public static string ImageFormat;
 
         /// <summary>
-        /// 
+        /// Default maximum characters allowd for active window title.
         /// </summary>
         private const int MAX_CHARS = 48000;
 
@@ -315,6 +315,11 @@ public struct DeviceOptions
         /// </summary>
         public int Count { get; set; }
 
+        /// <summary>
+        /// The numer of times the user did a "Capture Now".
+        /// </summary>
+        public int CountNow { get; set; }
+
         /// <summary>
         /// Determines if the screen capture session is locked.
         /// </summary>

changelog.txt

@@ -1,7 +1,7 @@
 Auto Screen Capture by Gavin Kendall
 
 
-2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle. New command "-restart".
+2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle. New command "-restart". New macro tag "%capturenow%".
 2.4.1.8    Delete Screenshots trigger uses ScreenshotsFolder instead of DefaultScreenshotsFolder. Sending a test email from Email Settings logs any exception error and the Send Test Email button is enabled again after an exception has been caught. Email Settings form accepts multiple email addresses in TO, CC, and BCC fields using either ; or , as a separator.
 2.4.1.7    Hash included in Screenshot Metadata. Additional debug logging has been included in the screen capture methods.
 2.4.1.6    $AppDataLocal$ and $AppDataRoaming$ introduced for autoscreen.conf and autoscreen.conf included as part of installation so that an installation of the application can run under normal user privileges without needing to run autoscreen.exe as Administrator from "C:\Program Files" or "C:\Program Files (x86)" since the data files are being written to the user's local or roaming app data folder (AppData\Local by default).

help/help-2.rtf

@@ -7699,7 +7699,7 @@ ad7bbdad7bbda57bbda57bbda57b000000040000002701ffff030000000000
 I love the Blade movies and I don't care what anyone says but the music in the "Bloodbath" nightclub scene of the first movie is still cool.\par
 The biggest feature implemented in 2.4 was the ability to encrypt and decrypt screenshots. The interface was cleaned up and more user-friendly notes were included. This version introduces the "Auto Adapt" feature for screens so that the position and size of each screen is automatically adjusted based on changes made to the display setup.\par
 Here's every change in the 2.4 "Blade" series (starting with the most recent change):\par
-\cf1\f1\fs19\lang1033 2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, \f2 Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle\f1 . New command "-restart".\par
+\cf1\f1\fs19\lang1033 2.4.1.9    Screenshots count is reset when screenshots limit is reached to avoid falling into an infinite loop. New trigger actions Restart Screen Capture, \f2 Delete Screenshots By Cycle Count, and Delete Screenshots From Oldest Capture Cycle\f1 . New command "-restart". \f2 New macro tag "%capturenow%".\f1\par
 2.4.1.8    \f2 Delete Screenshots trigger uses ScreenshotsFolder instead of DefaultScreenshotsFolder. Sending a test email from Email Settings logs any exception error and the Send Test Email button is enabled again after an exception has been caught. Email Settings form accepts multiple email addresses in TO, CC, and BCC fields using either ; or , as a separator.\f1\par
 2.4.1.7    \f2 Hash included in Screenshot Metadata. Additional debug logging has been included in the screen capture methods.\f1\lang9\par
 2.4.1.6    $AppDataLocal$ and $AppDataRoaming$ introduced for autoscreen.conf and autoscreen.conf included as part \lang1033 of \f2\lang9 installation so that an installation of the application can run under normal user privileges without needing to run autoscreen.exe as Administrator from "C:\\Program Files" or "C:\\Program Files (x86)" since the data files are being written to the user's local or roaming app data folder\f1\lang1033  (AppData\\Local by default)\f2\lang9 .\par

interface/macro_tag/FormMacroTag.cs

@@ -79,6 +79,7 @@ private void FormMacroTag_Load(object sender, EventArgs e)
             comboBoxType.Items.Add("Height");
             comboBoxType.Items.Add("Process Name");
             comboBoxType.Items.Add("Label");
+            comboBoxType.Items.Add("Capture Now Count");
 
             if (MacroTagObject != null)
             {

interface/main/FormMain-ScreenCapture.cs

@@ -120,6 +120,12 @@ private void TakeScreenshot(bool captureNow)
                 _screenCapture.Count++;
                 _screenCapture.CaptureNow = captureNow;
 
+                // Keep a count of how many times the user has used "Capture Now" so we can include it in a Macro Tag.
+                if (captureNow)
+                {
+                    _screenCapture.CountNow++;
+                }
+
                 DateTime dtNow = DateTime.Now;
 
                 _screenCapture.DateTimeScreenshotsTaken = dtNow;

interface/region_select/FormRegionSelectOptions.Designer.cs

@@ -55,7 +55,7 @@ private void FormRegionSelectOptions_Load(object sender, EventArgs e)
         private void LoadOptions()
         {
             textBoxAutoSaveFolder.Text = _config.Settings.User.GetByKey("AutoSaveFolder", _config.Settings.DefaultSettings.AutoSaveFolder).Value.ToString();
-            textBoxAutoSaveMacro.Text = _config.Settings.User.GetByKey("AutoSaveMacro", _config.Settings.DefaultSettings.AutoSaveMacro).Value.ToString();
+            textBoxAutoSaveFile.Text = _config.Settings.User.GetByKey("AutoSaveMacro", _config.Settings.DefaultSettings.AutoSaveMacro).Value.ToString();
 
             comboBoxFormat.Items.Clear();
 
@@ -70,7 +70,7 @@ private void LoadOptions()
         private void SaveOptions()
         {
             _config.Settings.User.GetByKey("AutoSaveFolder", _config.Settings.DefaultSettings.AutoSaveFolder).Value = textBoxAutoSaveFolder.Text.Trim();
-            _config.Settings.User.GetByKey("AutoSaveMacro", _config.Settings.DefaultSettings.AutoSaveMacro).Value = textBoxAutoSaveMacro.Text.Trim();
+            _config.Settings.User.GetByKey("AutoSaveMacro", _config.Settings.DefaultSettings.AutoSaveMacro).Value = textBoxAutoSaveFile.Text.Trim();
             _config.Settings.User.GetByKey("AutoSaveFormat", _config.Settings.DefaultSettings.AutoSaveFormat).Value = comboBoxFormat.Text;
 
             _config.Settings.User.Save(_config.Settings, _fileSystem);