Update Datetime node info (#13460)

QilongTang · web-flow · commit dfc1f5f996a3 · 2022-11-03T10:55:28.000-04:00
diff --git a/src/DynamoCore/Graph/Nodes/NodeInputData.cs b/src/DynamoCore/Graph/Nodes/NodeInputData.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Runtime.Serialization;
@@ -157,12 +157,12 @@ public override bool Equals(object obj)
         {
             var converted = obj as NodeInputData;
 
-            var valNumberComparison = false;
+            bool valNumberComparison;
             try
             {
                 valNumberComparison = Math.Abs(Convert.ToDouble(this.Value, CultureInfo.InvariantCulture) - Convert.ToDouble(converted.Value, CultureInfo.InvariantCulture)) < .000001;
             }
-            catch (Exception e)
+            catch (Exception)
             {
                 //this just stays false.
                 valNumberComparison = false;
diff --git a/src/Libraries/CoreNodeModels/Input/DateTime.cs b/src/Libraries/CoreNodeModels/Input/DateTime.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using Dynamo.Configuration;
@@ -23,6 +23,9 @@ private DateTime(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPorts
             ShouldDisplayPreviewCore = false;
         }
 
+        /// <summary>
+        /// Constructor
+        /// </summary>
         public DateTime()
         {
             Value = System.DateTime.UtcNow;
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs b/src/Libraries/CoreNodeModels/Properties/Resources.Designer.cs
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx b/src/Libraries/CoreNodeModels/Properties/Resources.en-US.resx
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -537,7 +537,7 @@
     <value>A converted numeric value.</value>
   </data>
   <data name="DateTimeDescription" xml:space="preserve">
-    <value>Creates a dateTime object from a formatted date and time string. Date and time must be in the format "April 12, 1977 12:00 PM"</value>
+    <value>Creates a dateTime object from a formatted date and time string. Date and time must be in the default DateTime format "MMMM dd, yyyy h:mm tt", e.g. "April 02, 1977 12:00 PM"</value>
   </data>
   <data name="ColorRangeSearchTags" xml:space="preserve">
     <value>colorrange;</value>
@@ -632,4 +632,4 @@ Default value: {0}</value>
   <data name="CustomSelectionOutputDescription" xml:space="preserve">
     <value>Selected value</value>
   </data>
-</root>
+</root>
diff --git a/src/Libraries/CoreNodeModels/Properties/Resources.resx b/src/Libraries/CoreNodeModels/Properties/Resources.resx
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -537,7 +537,7 @@
     <value>A converted numeric value.</value>
   </data>
   <data name="DateTimeDescription" xml:space="preserve">
-    <value>Creates a dateTime object from a formatted date and time string. Date and time must be in the format "April 12, 1977 12:00 PM"</value>
+    <value>Creates a dateTime object from a formatted date and time string. Date and time must be in the default DateTime format "MMMM dd, yyyy h:mm tt", e.g. "April 02, 1977 12:00 PM"</value>
   </data>
   <data name="ColorRangeSearchTags" xml:space="preserve">
     <value>colorrange;</value>
@@ -632,4 +632,4 @@ Default value: {0}</value>
   <data name="CustomSelectionOutputDescription" xml:space="preserve">
     <value>Selected value</value>
   </data>
-</root>
+</root>
diff --git a/src/Libraries/CoreNodeModelsWpf/Converters/StringToDateTimeOffsetConverter.cs b/src/Libraries/CoreNodeModelsWpf/Converters/StringToDateTimeOffsetConverter.cs
@@ -1,23 +1,42 @@
-﻿using System;
+using System;
 using System.Globalization;
 using System.Windows.Data;
 using Dynamo.Configuration;
 
 namespace CoreNodeModelsWpf.Converters
 {
+    /// <summary>
+    /// DateTime converter used for Date Time node value conversion
+    /// </summary>
     public class StringToDateTimeConverter : IValueConverter
     {
+        /// <summary>
+        /// Convert Date Time object to string using DefaultDateFormat
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="targetType"></param>
+        /// <param name="parameter"></param>
+        /// <param name="culture"></param>
+        /// <returns></returns>
         public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
         {
             return ((DateTime)value).ToString(PreferenceSettings.DefaultDateFormat, CultureInfo.InvariantCulture);
         }
 
+        /// <summary>
+        /// Convert input string to Date Time value, try to apply DefaultDateFormat.
+        /// If conversion fails, use default time.
+        /// </summary>
+        /// <param name="value"></param>
+        /// <param name="targetType"></param>
+        /// <param name="parameter"></param>
+        /// <param name="culture"></param>
+        /// <returns></returns>
         public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
         {
-            DateTime dt;
             return DateTime.TryParseExact(value.ToString(), PreferenceSettings.DefaultDateFormat,
-                CultureInfo.InvariantCulture, DateTimeStyles.None, out dt) ?
-                dt : PreferenceSettings.DynamoDefaultTime; 
+                CultureInfo.InvariantCulture, DateTimeStyles.None, out DateTime dt) ?
+                dt : PreferenceSettings.DynamoDefaultTime;
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Globalization;`
`4`	`4`	`using System.Runtime.Serialization;`
`@@ -157,12 +157,12 @@ public override bool Equals(object obj)`
`157`	`157`	`{`
`158`	`158`	`var converted = obj as NodeInputData;`
`159`	`159`
`160`		`- var valNumberComparison = false;`
	`160`	`+ bool valNumberComparison;`
`161`	`161`	`try`
`162`	`162`	`{`
`163`	`163`	`valNumberComparison = Math.Abs(Convert.ToDouble(this.Value, CultureInfo.InvariantCulture) - Convert.ToDouble(converted.Value, CultureInfo.InvariantCulture)) < .000001;`
`164`	`164`	`}`
`165`		`- catch (Exception e)`
	`165`	`+ catch (Exception)`
`166`	`166`	`{`
`167`	`167`	`//this just stays false.`
`168`	`168`	`valNumberComparison = false;`