Release v3.0.0

Author: rabanti-github

Changelog.md

@@ -1,5 +1,79 @@
 # Change Log
 
+## v3.0.0
+
+---
+Release Date: **03.09.2022 - Major Release**
+
+Note: some of the mentioned changes may be already implemented in v2.x as preview functionality
+
+### Workbook and Shortener
+
+- Added a list of MRU colors that can be defined in the Workbook class (methods AddMruColor, ClearMruColors)
+- Added an exposed property for the workbook protection password hash (will be filled when loading a workbook)
+- Added the method SetSelectedWorksheet by name in the Workbook class
+- Added two methods GetWorksheet by name or index in the Workbook class
+- Added the methods CopyWorksheetIntoThis and CopyWorksheetTo with several overloads in the Workbook class
+- Added the function RemoveWorksheet by index with the option of resetting the current worksheet, in the Workbook class
+- Added the function SetCurrentWorksheet by index in the Workbook class
+- Added the function SetSelectedWorksheet by name in the Workbook class
+- Added a Shortener-Class constructor with a workbook reference
+- The shortener functions Down and Right have now an option to keep row and column positions
+- Added two shortener functions Up and Left
+- Made several style assigning methods deprecated in the Workbook class (will be removed in future versions)
+
+### Worksheet
+
+- Added an exposed property for the worksheet protection password hash (will be filled when loading a workbook)
+- Added the methods GetFirstDataColumnNumber, GetFirstDataColumnNumber, GetFirstDataRowNumber, GetFirstRowNumber, GetLastDataColumnNumber, GetFirstCellAddress, GetFirstDataCellAddress, GetLastDataColumnNumber, GetLastDataRowNumber, GetLastRowNumber, GetLastCellAddress,  GetLastCellAddress and GetLastDataCellAddress
+- Added the methods GetRow and GetColumns by address string or index
+- Added the method Copy to copy a worksheet (deep copy)
+- Added a constructor with only the worksheet name as parameter
+- Added and option in GoToNextColumn and GoToNextRow to either keep the current row or column
+- Added the methods RemoveRowHeight and RemoveAllowedActionOnSheetProtection
+- Renamed columnAddress and rowAddress to columnNumber and rowNumber in the AddNextCell, AddCellFormula and RemoveCell methods
+- Added several validations for worksheet data
+
+### Cells, Rows and Columns
+
+- In Cell, the address can now have reference modifiers ($)
+- The worksheet reference in the Cell constructor was removed. Assigning to a worksheet is now managed automatically by the worksheet when adding a cell
+- Added a property CellAddressType in Cell
+- Cells can now have null as value, interpreted as empty
+- Added a new overloaded function ResolveCellCoordinate to resolve the address type as well
+- Added ValidateColumnNumber and ValidateRowNumber in Cell
+- In Address, the constructor with string and address type now only needs a string, since reference modifiers ($) are resolved automatically
+- Address objects are now comparable
+- Implemented better address validation
+- Range start and end addresses are swapped automatically, if reversed
+
+### Styles
+
+- Font has now an enum of possible underline values (e.g. instead of a bool)
+- CellXf supports now indentation
+- A new, internal style repository was introduced to streamline the style management
+- Color (RGB) values are now validated (Fill class has a function ValidateColor)
+- Style components have now more appropriate default values
+- MRU colors are now not collected from defined style colors but from the MRU list in the workbook object
+- The ToString function of Styles and all sub parts will now give a complete outline of all elements
+- Fixed several issues with style comparison
+- Several style default values were introduced as constants
+
+### Formulas
+
+- Added uint as possible formula value. Valid types are int, uint, long, ulong, float, double, byte, sbyte, decimal, short and ushort
+- Added several validity checks
+
+
+### Misc
+- Added several constants for boundary dates in the LowLevel class
+- Added several functions for pane splitting in the LowLevel class
+- Exposed the (legacy) password generation method in the LowLevel class
+- Updated documentation among the whole project
+- Exceptions have no sub-tiles anymore
+- Overhauled the whole writer
+- Removed lot of dead code for better maintenance
+
 ## v2.11.5
 
 ---

Demo .NET Standard/Demo .NET Standard.csproj

@@ -8,15 +8,18 @@
     <Copyright>Copyright Raphael Stoeckli © 2022</Copyright>
     <RepositoryUrl>https://github.com/rabanti-github/PicoXLSX.git</RepositoryUrl>
     <PackageProjectUrl>https://github.com/rabanti-github/PicoXLSX</PackageProjectUrl>
-    <AssemblyVersion>2.11.5.0</AssemblyVersion>
-    <FileVersion>2.11.5.0</FileVersion>
-    <Version>2.11.5</Version>
+    <AssemblyVersion>3.0.0.0</AssemblyVersion>
+    <FileVersion>2.0.0.0</FileVersion>
+    <Version>3.0.0</Version>
     <Description>Demo Library showing the use of PicoXLSX, a library to generate Microsoft Excel files (XLSX) in an easy and native way</Description>
     <StartupObject>Demo.Program</StartupObject>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageIcon>PicoXLSX.png</PackageIcon>
     <PackageIconUrl />
     <PackageTags>XLSX Excel ExcelWriter Office</PackageTags>
+    <Company />
+    <Product>PicoXLSX</Product>
+    <Authors>Raphael Stoeckli</Authors>
   </PropertyGroup>
 
   <ItemGroup>

Demo/Program.cs

@@ -233,7 +233,7 @@ private static void Demo4()
 
             Style s = new Style();                                                                           // Create new style
             s.CurrentFill.SetColor("FF22FF11", Style.Fill.FillType.fillColor);                               // Set fill color
-            s.CurrentFont.DoubleUnderline = true;                                                            // Set double underline
+            s.CurrentFont.Underline = Style.Font.UnderlineValue.u_double;                                    // Set double underline
             s.CurrentCellXf.HorizontalAlign = Style.CellXf.HorizontalAlignValue.center;                      // Set alignment
 
             Style s2 = s.CopyStyle();                                                                        // Copy the previously defined style

Demo/Properties/AssemblyInfo.cs

@@ -5,11 +5,11 @@
 // General Information about an assembly is controlled through the following 
 // set of attributes. Change these attribute values to modify the information
 // associated with an assembly.
-[assembly: AssemblyTitle("Demo")]
+[assembly: AssemblyTitle("PicoXLSX Demo")]
 [assembly: AssemblyDescription("")]
 [assembly: AssemblyConfiguration("")]
 [assembly: AssemblyCompany("")]
-[assembly: AssemblyProduct("Demo")]
+[assembly: AssemblyProduct("PicoXLSX")]
 [assembly: AssemblyCopyright("Copyright Raphael Stoeckli © 2022")]
 [assembly: AssemblyTrademark("")]
 [assembly: AssemblyCulture("")]
@@ -32,5 +32,5 @@
 // You can specify all the values or you can default the Build and Revision Numbers 
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("2.11.5.0")]
-[assembly: AssemblyFileVersion("2.11.5.0")]
+[assembly: AssemblyVersion("3.0.0.0")]
+[assembly: AssemblyFileVersion("3.0.0.0")]

PicoXLSX .NET Standard/PicoXLSX .NET Standard.csproj

@@ -4,9 +4,9 @@
     <TargetFrameworks>netstandard2.0;net45</TargetFrameworks>
     <RootNamespace>PicoXLSX</RootNamespace>
     <PackageId>PicoXLSX</PackageId>
-    <Version>2.11.5</Version>
+    <Version>3.0.0</Version>
     <Authors>Raphael Stoeckli</Authors>
-    <Company>Raphael Stoeckli</Company>
+    <Company></Company>
     <Product>PicoXLSX</Product>
     <Description>PicoXLSX is a library to generate Microsoft Excel files (XLSX) in an easy and native way</Description>
     <Copyright>Copyright Raphael Stoeckli © 2022</Copyright>
@@ -17,8 +17,9 @@
     <PackageTags>Excel Office XLSX</PackageTags>
     <PackageReleaseNotes>Please see https://github.com/rabanti-github/PicoXLSX/blob/master/Changelog.md for the release notes</PackageReleaseNotes>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <AssemblyVersion>2.11.5.0</AssemblyVersion>
-    <FileVersion>2.11.5.0</FileVersion>
+    <AssemblyVersion>3.0.0.0</AssemblyVersion>
+    <FileVersion>3.0.0.0</FileVersion>
+    <AssemblyName>PicoXLSX</AssemblyName>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">

PicoXLSX/Cell.cs

@@ -300,6 +300,24 @@ public Style SetStyle(Style style, bool unmanaged = false)
             return cellStyle;
         }
 
+        /// <summary>
+        /// Copies this cell into a new one. The style is considered if not null.
+        /// </summary>
+        /// <returns>Copy of this cell</returns>
+        internal Cell Copy()
+        {
+            Cell copy = new Cell();
+            copy.Value = this.Value;
+            copy.DataType = this.DataType;
+            copy.CellAddress = this.CellAddress;
+            copy.CellAddressType = this.CellAddressType;
+            if (this.cellStyle != null)
+            {
+                copy.SetStyle(this.cellStyle, true);
+            }
+            return copy;
+        }
+
         #endregion
 
         #region staticMethods
@@ -634,7 +652,7 @@ public static string ResolveColumnAddress(int columnNumber)
         /// </summary>
         /// <param name="addressExpression">Address expression</param>
         /// <returns>Scope of the address expression</returns>
-        public static AddressScope GetAddressScope(String addressExpression)
+        public static AddressScope GetAddressScope(string addressExpression)
         {
             try
             {
@@ -780,6 +798,15 @@ public int CompareTo(Address other)
                 return thisCoordinate.CompareTo(otherCoordinate);
             }
 
+            /// <summary>
+            /// Creates a (dereferenced, if applicable) deep copy of this address
+            /// </summary>
+            /// <returns>Copy of this range</returns>
+            internal Address Copy()
+            {
+                return new Address(this.Column, this.Row, this.Type);
+            }
+
         }
 
         /// <summary>
@@ -813,6 +840,7 @@ public Range(Address start, Address end)
                     StartAddress = end;
                     EndAddress = start;
                 }
+
             }
 
             /// <summary>
@@ -880,6 +908,15 @@ public override string ToString()
             {
                 return StartAddress.ToString() + ":" + EndAddress.ToString();
             }
+
+            /// <summary>
+            /// Creates a (dereferenced, if applicable) deep copy of this range
+            /// </summary>
+            /// <returns>Copy of this range</returns>
+            internal Range Copy()
+            {
+                return new Range(this.StartAddress.Copy(), this.EndAddress.Copy());
+            }
         }
 
         /// <summary>