Merge branch 'dev' into master

Author: rabanti-github

Changelog.md

@@ -1,5 +1,22 @@
 # Change Log
 
+## v1.4.0
+
+---
+Release Date: **30.08.2020**
+
+- Added style reader to resolve dates and times properly
+- Added new data type TIME, represented by TimeSpan objects in reader and writer
+- Changed namespace from 'Styles' to 'NanoXLSX.Styles'
+- Added time (TimeSpan) examples to the demos
+- Updated documentation
+- Fixed some code formatting issues
+
+### Notes:
+ * To be consistent, the namespace of 'Styles' was changed to 'NanoXLSX.Styles'. Minor changes may be necessary in existing code if styles were used
+ * Currently, the style reader resolves only number formats to determine dates and times, as well as custom formats. Other components like fonts, borders or fills are neglected at the moment
+
+
 ## v1.3.6
 
 ---

Demo/Program.cs

@@ -5,6 +5,7 @@
  * You find a copy of the license in project folder or on: http://opensource.org/licenses/MIT
  */
 
+using NanoXLSX.Styles;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -62,7 +63,7 @@ public static void StressTest(string filename, string sheetname, int rows, int c
             {
                 for (j = 0; j < cols; j++)
                 {
-                    s.AddNextCell(field[i][j], Styles.BasicStyles.Bold);
+                    s.AddNextCell(field[i][j], BasicStyles.Bold);
                 }
                 s.GoToNextRow();
             }

Demo/Testing/Performance.cs

@@ -104,7 +104,7 @@ public static bool PseudoRandomBool()
         /// <param name="minLength">Minimum date</param>
         /// <param name="maxLength">Maximum date</param>
         /// <returns>Randomly generated DateTime</returns>
-        /// <remarks>Excel, respectively its OADate function does not support a dates before 30th December 1899. Such dates will cause an exception in NanoXLSX</remarks>
+        /// <remarks>Excel, respectively its OAdate function does not support a dates before January 1st 1900 and after December 31 9999. Such dates will cause an exception in NanoXLSX</remarks>
         public static DateTime PseduoRandomDate(DateTime min, DateTime max)
         {
             long ticks = PseudoRandomLong(min.Ticks, max.Ticks);

Demo/Testing/Utils.cs

@@ -10,7 +10,7 @@
 using System.Text;
 using System.Text.RegularExpressions;
 using NanoXLSX.Exceptions;
-using Styles;
+using NanoXLSX.Styles;
 using FormatException = NanoXLSX.Exceptions.FormatException;
 
 namespace NanoXLSX
@@ -31,8 +31,10 @@ public enum CellType
             STRING,
             /// <summary>Type for all numeric types (long, integer and float and double)</summary>
             NUMBER,
-            /// <summary>Type for dates and times (Note: Dates before 1900-01-01 are not allowed)</summary>
+            /// <summary>Type for dates(Note: Dates before 1900-01-01 and after 9999-12-31 are not allowed)</summary>
             DATE,
+            /// <summary>Type for times (Note: Internally handled as OAdate, represented by <see cref="TimeSpan"/>)</summary>
+            TIME,
             /// <summary>Type for boolean</summary>
             BOOL,
             /// <summary>Type for Formulas (The cell will be handled differently)</summary>
@@ -164,7 +166,7 @@ public Cell(object value, CellType type)
         }
 
         /// <summary>
-        /// Constructor with value, cell type and address. The worksheet reference is set to null and must be assigned later
+        /// Constructor with value, cell type and address as string. The worksheet reference is set to null and must be assigned later
         /// </summary>
         /// <param name="value">Value of the cell</param>
         /// <param name="type">Type of the cell</param>
@@ -181,6 +183,25 @@ public Cell(Object value, CellType type, string address)
             }
         }
 
+        /// <summary>
+        /// Constructor with value, cell type and address as struct. The worksheet reference is set to null and must be assigned later
+        /// </summary>
+        /// <param name="value">Value of the cell</param>
+        /// <param name="type">Type of the cell</param>
+        /// <param name="address">Address struct of the cell</param>
+        public Cell(Object value, CellType type, Address address)
+        {
+            DataType = type;
+            Value = value;
+            columnNumber = address.Column;
+            rowNumber = address.Row;
+            WorksheetReference = null;
+            if (type == CellType.DEFAULT)
+            {
+                ResolveCellType();
+            }
+        }
+
         /// <summary>
         /// Constructor with value, cell type, row number, column number and the link to a worksheet
         /// </summary>
@@ -261,6 +282,7 @@ public void ResolveCellType()
             else if (t == typeof(long) || t == typeof(ulong)) { DataType = CellType.NUMBER; }
             else if (t == typeof(short) || t == typeof(ushort)) { DataType = CellType.NUMBER; }
             else if (t == typeof(DateTime)) { DataType = CellType.DATE; } // Not native but standard
+            else if (t == typeof(TimeSpan)) { DataType = CellType.TIME; } // Not native but standard
             else { DataType = CellType.STRING; } // Default (char, string, object)
         }
 
@@ -344,6 +366,7 @@ public static List<Cell> ConvertArray<T>(List<T> list)
                 else if (t == typeof(short))   { c = new Cell((short)o, CellType.NUMBER); }
                 else if (t == typeof(ushort))  { c = new Cell((ushort)o, CellType.NUMBER); }
                 else if (t == typeof(DateTime)){ c = new Cell((DateTime)o, CellType.DATE); }
+                else if (t == typeof(TimeSpan)){ c = new Cell((TimeSpan)o, CellType.TIME); }
                 else if (t == typeof(string))  { c = new Cell((string)o, CellType.STRING); }
                 else // Default = unspecified object
                 {

Executable/Documentation.chm

@@ -33,6 +33,16 @@ public StyleException()
         public StyleException(string title, string message)
             : base(title + ": " + message)
         { ExceptionTitle = title; }
+
+        /// <summary>
+        /// Constructor with passed message and inner exception
+        /// </summary>
+        /// <param name="message">Message of the exception</param>
+        /// <param name="inner">Inner exception</param>
+        /// <param name="title">Title of the exception</param>
+        public StyleException(string title, string message, Exception inner)
+            : base(message, inner)
+        { ExceptionTitle = title; }
     }
 
 }

NanoXLSX/Cell.cs

@@ -0,0 +1,81 @@
+/*
+ * NanoXLSX is a small .NET library to generate and read XLSX (Microsoft Excel 2007 or newer) files in an easy and native way  
+ * Copyright Raphael Stoeckli © 2020
+ * This library is licensed under the MIT License.
+ * You find a copy of the license in project folder or on: http://opensource.org/licenses/MIT
+ */
+
+using System;
+using System.Collections.Generic;
+
+namespace NanoXLSX
+{
+    /// <summary>
+    /// The import options define global rules to import worksheets. The options are mainly to override particular cell types (e.g. interpretation of dates as numbers)
+    /// </summary>
+    public class ImportOptions
+    {
+        /// <summary>
+        /// Column types to enforce during the import
+        /// </summary>
+        public enum ColumnType
+        {
+            /// <summary>
+            /// Cells are tried to be imported as numbers (double)
+            /// </summary>
+            Numeric,
+            /// <summary>
+            /// Cells are tried to be imported as dates (DateTime)
+            /// </summary>
+            Date,
+            /// <summary>
+            /// Cells are tried to be imported as times (TimeSpan)
+            /// </summary>
+            Time,
+            /// <summary>
+            /// Cells are tried to be imported as bools
+            /// </summary>
+            Bool,
+            /// <summary>
+            /// Cells are all imported as strings, using the ToString() method
+            /// </summary>
+            String
+        }
+
+        /// <summary>
+        /// If true, date or time values (default style number 1 or 3) will be interpreted as numeric values globally. This option overrules possible column options, defined by <see cref="AddEnforcedColumn(int, ColumnType)"/>.
+        /// </summary>
+        public bool EnforceDateTimesAsNumbers { get; set; } = false;
+
+
+        /// <summary>
+        /// Type enforcing rules during import for particular columns
+        /// </summary>
+        public Dictionary<int, ColumnType> EnforcedColumnTypes { get; private set; } = new Dictionary<int, ColumnType>();
+
+        /// <summary>
+        /// The row number (zero-based) where enforcing rules are started to be applied. This is, for instance, to prevent enforcing in a header row
+        /// </summary>
+        public int EnforcingStartRowNumber { get; set; } = 0;
+
+        /// <summary>
+        /// Adds a type enforcing rule to the passed column address
+        /// </summary>
+        /// <param name="columnAddress">Column address (A to XFD)</param>
+        /// <param name="type">Type to be enforced on the column</param>
+        public void AddEnforcedColumn(string columnAddress, ColumnType type)
+        {
+            this.EnforcedColumnTypes.Add(Cell.ResolveColumn(columnAddress), type);
+        }
+
+        /// <summary>
+        /// Adds a type enforcing rule to the passed column number (zero-based)
+        /// </summary>
+        /// <param name="columnNumber">Column number (0-16383)</param>
+        /// <param name="type">Type to be enforced on the column</param>
+        public void AddEnforcedColumn(int columnNumber, ColumnType type)
+        {
+            this.EnforcedColumnTypes.Add(columnNumber, type);
+        }
+    }
+}

NanoXLSX/Exceptions/StyleException.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using System.Xml;
+
+namespace NanoXLSX.LowLevel
+{
+    /// <summary>
+    /// Static class with common util methods, used during reading XLSX files
+    /// </summary>
+    public static class ReaderUtils
+    {
+        /// <summary>
+        /// Gets the XML attribute of the passed XML node by its name
+        /// </summary>
+        /// <param name="targetName">Name of the target attribute</param>
+        /// <param name="node">XML node that contains the attribute</param>
+        /// <param name="fallbackValue">Optional fallback value if the attribute was not found. Default is null</param>
+        /// <returns>Attribute value as string or default value if not found (can be null)</returns>
+        public static string GetAttribute(string targetName, XmlNode node, string fallbackValue = null)
+        {
+            if (node.Attributes == null || node.Attributes.Count == 0)
+            {
+                return fallbackValue;
+            }
+
+            foreach (XmlAttribute attribute in node.Attributes)
+            {
+                if (attribute.Name == targetName)
+                {
+                    return attribute.Value;
+                }
+            }
+
+            return fallbackValue;
+        }
+    }
+}