Version 6.0 (#194)

Author: snakefoot

NLog.Windows.Forms.Tests/ApiTests.cs

@@ -168,23 +168,6 @@ public void WrapperLayoutRenderer_EnsureThreadAgnostic()
             }
         }
 
-        [Fact]
-        public void RequiredConfigOptionMustBeClass()
-        {
-            foreach (Type type in allTypes)
-            {
-                var properties = type.GetProperties(BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
-                foreach (var prop in properties)
-                {
-                    var requiredParameter = prop.GetCustomAttribute<NLog.Config.RequiredParameterAttribute>();
-                    if (requiredParameter != null)
-                    {
-                        Assert.True(prop.PropertyType.IsClass, prop.Name);
-                    }
-                }
-            }
-        }
-
         [Fact]
         public void SingleDefaultConfigOption()
         {

NLog.Windows.Forms.Tests/NLog.Windows.Forms.Tests.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup>
-		<TargetFrameworks>net461;netcoreapp3.1;net6.0-windows</TargetFrameworks>
+		<TargetFrameworks>net462;netcoreapp3.1;net6.0-windows</TargetFrameworks>
     <UseWindowsForms>true</UseWindowsForms>
 		<SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\</SolutionDir>
 		<AssemblyTitle>NLog.Windows.Forms.Tests</AssemblyTitle>
@@ -21,9 +21,8 @@
 		<AssemblyOriginatorKeyFile>NLog.snk</AssemblyOriginatorKeyFile>
 	</PropertyGroup>
 	<ItemGroup>
-		<PackageReference Include="xunit" Version="2.8.0" />
-		<PackageReference Include="xunit.extensibility.execution" Version="2.8.0" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
+		<PackageReference Include="xunit" Version="2.8.1" />
+		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>

NLog.Windows.Forms.Tests/RichTextBoxTargetTests.cs

@@ -160,7 +160,9 @@ public void CustomRowColoringTest()
                     ToolWindow = false,
                     RowColoringRules =
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         new RichTextBoxRowColoringRule("starts-with(message, 'B')", "Maroon", "Empty"),
+#pragma warning restore CS0618 // Type or member is obsolete
                     }
                 };
 
@@ -235,8 +237,10 @@ public void CustomWordRowColoringTest()
                     ToolWindow = false,
                     WordColoringRules =
                     {
+#pragma warning disable CS0618 // Type or member is obsolete
                         new RichTextBoxWordColoringRule("zzz", "Red", "Empty"),
                         new RichTextBoxWordColoringRule("aaa", "Green", "Empty"),
+#pragma warning restore CS0618 // Type or member is obsolete
                     }
                 };
 
@@ -301,10 +305,10 @@ public void RichTextBoxTargetDefaultsTest()
         {
             var target = new RichTextBoxTarget();
             Assert.False(target.UseDefaultRowColoringRules);
-            Assert.Equal(0, target.WordColoringRules.Count);
-            Assert.Equal(0, target.RowColoringRules.Count);
-            Assert.Null(target.FormName);
-            Assert.Null(target.ControlName);
+            Assert.Empty(target.WordColoringRules);
+            Assert.Empty(target.RowColoringRules);
+            Assert.Empty(target.FormName?.ToString());
+            Assert.Empty(target.ControlName?.ToString());
         }
 
         [Fact]
@@ -379,12 +383,14 @@ public void ColoringRuleDefaults()
         {
             var expectedRules = new[]
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 new RichTextBoxRowColoringRule("level == LogLevel.Fatal", "White", "Red", FontStyle.Bold),
                 new RichTextBoxRowColoringRule("level == LogLevel.Error", "Red", "Empty", FontStyle.Bold | FontStyle.Italic),
                 new RichTextBoxRowColoringRule("level == LogLevel.Warn", "Orange", "Empty", FontStyle.Underline),
                 new RichTextBoxRowColoringRule("level == LogLevel.Info", "Black", "Empty"),
                 new RichTextBoxRowColoringRule("level == LogLevel.Debug", "Gray", "Empty"),
                 new RichTextBoxRowColoringRule("level == LogLevel.Trace", "DarkGray", "Empty", FontStyle.Italic),
+#pragma warning restore CS0618 // Type or member is obsolete
             };
 
             var actualRules = RichTextBoxTarget.DefaultRowColoringRules;
@@ -507,11 +513,11 @@ public void ActiveFormNegativeTest1()
                         builder.ForLogger().WriteTo(target);
                     }).LogFactory;
 
-                    Assert.True(false, "Expected exception.");
+                    Assert.Fail("Expected exception.");
                 }
                 catch (NLogConfigurationException ex)
                 {
-                    Assert.Equal("Rich text box control 'Control1' cannot be found on form 'MyForm1'.", ex.Message);
+                    Assert.Equal("RichTextBoxTarget(Name=RichTextBox): Rich text box control 'Control1' cannot be found on form 'MyForm1'.", ex.Message);
                 }
             }
         }
@@ -539,11 +545,12 @@ public void ActiveFormNegativeTest2()
                     {
                         builder.ForLogger().WriteTo(target);
                     }).LogFactory;
-                    Assert.True(false, "Expected exception.");
+
+                    Assert.Fail("Expected exception.");
                 }
                 catch (NLogConfigurationException ex)
                 {
-                    Assert.Equal("Rich text box control name must be specified for RichTextBoxTarget.", ex.Message);
+                    Assert.Equal("RichTextBoxTarget(Name=RichTextBox): Rich text box ControlName must be specified.", ex.Message);
                 }
             }
         }

NLog.Windows.Forms/FormControlTarget.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Windows.Forms;
 using NLog.Common;
-using NLog.Config;
 using NLog.Layouts;
 using NLog.Targets;
 
@@ -36,7 +35,6 @@ public sealed class FormControlTarget : TargetWithLayout
         /// </remarks>
         public FormControlTarget()
         {
-            Append = true;
         }
 
         private delegate void DelSendTheMessageToFormControl(Control control, string logMessage, bool append, bool reverseOrder);
@@ -45,58 +43,71 @@ public FormControlTarget()
         /// Gets or sets the name of control to which NLog will log write log text.
         /// </summary>
         /// <docgen category='Form Options' order='10' />
-        [RequiredParameter]
-        public Layout ControlName { get; set; }
+        public Layout ControlName { get; set; } = Layout.Empty;
 
         /// <summary>
         /// Gets or sets a value indicating whether log text should be appended to the text of the control instead of overwriting it. </summary>
         /// <docgen category='Form Options' order='10' />
-        public Layout<bool> Append { get; set; }
+        public Layout<bool> Append { get; set; } = true;
 
         /// <summary>
         /// Gets or sets the name of the Form on which the control is located.
         /// </summary>
         /// <docgen category='Form Options' order='10' />
-        public Layout FormName { get; set; }
+        public Layout? FormName { get; set; }
 
         /// <summary>
         /// Gets or sets whether new log entry are added to the start or the end of the control
         /// </summary>
-        public Layout<bool> ReverseOrder { get; set; }
+        public Layout<bool> ReverseOrder { get; set; } = false;
+
+        /// <inheritdoc />
+        protected override void InitializeTarget()
+        {
+            if (ControlName is null || ReferenceEquals(ControlName, Layout.Empty))
+                throw new NLogConfigurationException("FormControlTarget ControlName-property must be assigned.");
+
+            base.InitializeTarget();
+        }
 
         /// <summary>
         /// Log message to control.
         /// </summary>
-        /// <param name="logEvent">
-        /// The logging event.
-        /// </param>
+        /// <param name="logEvent">The logging event.</param>
         protected override void Write(LogEventInfo logEvent)
         {
             string logMessage = RenderLogEvent(Layout, logEvent);
 
-            Form form = null;
+            Form? form = null;
 
             if (Form.ActiveForm != null)
             {
                 form = Form.ActiveForm;
             }
 
-            string renderedFormName = RenderLogEvent(FormName, logEvent);
-            if (Application.OpenForms[renderedFormName] != null)
+            string formName = RenderLogEvent(FormName, logEvent);
+            if (Application.OpenForms[formName] != null)
             {
-                form = Application.OpenForms[renderedFormName];
+                form = Application.OpenForms[formName];
             }
 
-            if (form == null)
+            if (form is null)
             {
-                InternalLogger.Info("Form {0} not found", FormName);
+                if (string.IsNullOrEmpty(formName))
+                    formName = FormName?.ToString() ?? string.Empty;
+                InternalLogger.Info("Form {0} not found", formName);
                 return;
             }
 
-            Control control = FormHelper.FindControl(RenderLogEvent(ControlName, logEvent), form);
-            if (control == null)
+            var controlName = RenderLogEvent(ControlName, logEvent);
+            var control = FormHelper.FindControl(controlName, form);
+            if (control is null)
             {
-                InternalLogger.Info("Control {0} on Form {1} not found", ControlName, FormName);
+                if (string.IsNullOrEmpty(controlName))
+                    controlName = ControlName?.ToString() ?? string.Empty;
+                if (string.IsNullOrEmpty(formName))
+                    formName = form.Name;
+                InternalLogger.Info("Control {0} on Form {1} not found", controlName, formName);
                 return;
             }
 
@@ -117,7 +128,7 @@ protected override void Write(LogEventInfo logEvent)
             }
         }
 
-        private void SendTheMessageToFormControl(Control control, string logMessage, bool append, bool reverseOrder)
+        private static void SendTheMessageToFormControl(Control control, string logMessage, bool append, bool reverseOrder)
         {
             //append of replace?
             if (append)

NLog.Windows.Forms/FormHelper.cs

@@ -36,16 +36,16 @@ internal static RichTextBox CreateRichTextBox(string name, Form parentForm)
         /// <param name="name">Name of the control.</param>
         /// <param name="searchControl">Control in which we're searching for control.</param>
         /// <returns>A value of null if no control has been found.</returns>
-        internal static Control FindControl(string name, Control searchControl)
+        internal static Control? FindControl(string name, Control? searchControl)
         {
-            if (searchControl.Name == name)
+            if (searchControl is null || searchControl.Name == name)
             {
-                return searchControl;    
+                return searchControl;
             }
 
-            foreach (Control childControl in searchControl.Controls)
+            foreach (var childControl in searchControl.Controls)
             {
-                Control foundControl = FindControl(name, childControl);
+                var foundControl = FindControl(name, childControl as Control);
                 if (foundControl != null)
                 {
                     return foundControl;
@@ -61,25 +61,25 @@ internal static Control FindControl(string name, Control searchControl)
         /// <param name="name">Name of the ToolStripItem</param>
         /// <param name="searchCollection">Collection of ToolStripItem we are looking for the item in.</param>
         /// <returns>A value of null of no item has been found.</returns>
-        internal static ToolStripItem FindToolStripItem(string name, ToolStripItemCollection searchCollection)
+        internal static ToolStripItem? FindToolStripItem(string name, ToolStripItemCollection searchCollection)
         {
-            foreach (ToolStripItem childItem in searchCollection)
+            foreach (ToolStripItem? childItem in searchCollection)
             {
-                if(childItem.Name == name)
+                if (childItem?.Name == name)
                 {
                     return childItem;
                 }
-                if(childItem is ToolStripDropDownItem)
-                {
-                    ToolStripDropDownItem childDropDown = childItem as ToolStripDropDownItem;
-                    ToolStripItem foundItem = FindToolStripItem(name, childDropDown.DropDownItems);
 
+                if (childItem is ToolStripDropDownItem childDropDown)
+                {
+                    var foundItem = FindToolStripItem(name, childDropDown.DropDownItems);
                     if (foundItem != null)
                     {
                         return foundItem;
                     }
                 }
             }
+
             return null;
         }
 
@@ -92,22 +92,24 @@ internal static ToolStripItem FindToolStripItem(string name, ToolStripItemCollec
         /// <returns>
         /// A value of null if no control has been found.
         /// </returns>
-        internal static TControl FindControl<TControl>(string name, Control searchControl)
+        internal static TControl? FindControl<TControl>(string name, Control? searchControl)
             where TControl : Control
         {
+            if (searchControl is null)
+                return null;
+
             if (searchControl.Name == name)
             {
-                TControl foundControl = searchControl as TControl;
+                var foundControl = searchControl as TControl;
                 if (foundControl != null)
                 {
                     return foundControl;
                 }
             }
 
-            foreach (Control childControl in searchControl.Controls)
+            foreach (var childControl in searchControl.Controls)
             {
-                TControl foundControl = FindControl<TControl>(name, childControl);
-
+                var foundControl = FindControl<TControl>(name, childControl as Control);
                 if (foundControl != null)
                 {
                     return foundControl;
@@ -171,15 +173,18 @@ internal static Form CreateForm(string name, int width, int height, bool show, b
             return f;
         }
 
-        private static Icon GetNLogIcon()
+        private static Icon? GetNLogIcon()
         {
             using (var stream = typeof(FormHelper).Assembly.GetManifestResourceStream("NLog.Windows.Forms.Resources.NLog.ico"))
             {
+                if (stream is null)
+                    return null;
+
                 return new Icon(stream);
             }
         }
 
-#region Link support
+        #region Link support
         /// <summary>
         /// Replaces currently selected text in the RTB control with a link
         /// </summary>
@@ -191,9 +196,7 @@ private static Icon GetNLogIcon()
         /// </remarks>
         internal static void ChangeSelectionToLink(RichTextBox textBox, string text, string hyperlink)
         {
-#if NETCOREAPP
-            textBox.SelectedRtf = @"{\rtf1\ansi{\field{\*\fldinst{HYPERLINK """ + text + @"#" + hyperlink + @""" }}{\fldrslt{" + text + @"}}}}";
-#else
+#if NETFRAMEWORK
             int selectionStart = textBox.SelectionStart;
 
             //using \v tag to hide hyperlink part of the text, and \v0 to end hiding. See http://stackoverflow.com/a/14339531/376066
@@ -202,9 +205,12 @@ internal static void ChangeSelectionToLink(RichTextBox textBox, string text, str
 
             textBox.Select(selectionStart, text.Length + 1 + hyperlink.Length); //now select both visible and invisible part
             SetSelectionStyle(textBox, CFM_LINK, CFE_LINK);                     //and turn into a link
+#else
+            textBox.SelectedRtf = @"{\rtf1\ansi{\field{\*\fldinst{HYPERLINK """ + text + @"#" + hyperlink + @""" }}{\fldrslt{" + text + @"}}}}";
 #endif
         }
 
+#if NETFRAMEWORK
         /// <summary>
         /// Sets selection style for RichTextBox
         /// https://msdn.microsoft.com/en-us/library/windows/desktop/bb787883(v=vs.85).aspx
@@ -269,6 +275,7 @@ private struct CHARFORMAT2_STRUCT
 
         [DllImport("user32.dll", CharSet = CharSet.Auto)]
         private static extern IntPtr SendMessage(IntPtr hWnd, int msg, IntPtr wParam, IntPtr lParam);
+#endif
 #endregion
     }
 }