Update v2.2.0

Author: rabanti-github

Changelog.md

@@ -1,12 +1,20 @@
 # Change Log
 
+## v2.2.0
+---
+Release Date: **10.12.2017**
+
+- Added Shortener class (WS) in workbook for quicker writing of data / formulas
+- Updated descriptions
+- Added full NuGet support
+
 ## v2.1.1
 ---
 Release Date: **07.12.2017**
 
 - Documentation Update
 - Fixed version number of the assembly
-- Preparation for Nuget release
+- Preparation for NuGet release
 
 ## v2.1.0
 ---

Demo/Program.cs

@@ -22,6 +22,7 @@ class Program
         static void Main(string[] args)
         {
             BasicDemo();
+            ShortenerDemo();
             StreamDemo();
             Demo1();
             Demo2();
@@ -52,6 +53,25 @@ private static void BasicDemo()
             workbook.Save();
         }
 
+        /// <summary>
+        /// This method show the shortened style of writing cells
+        /// </summary>
+        private static void ShortenerDemo()
+        {
+            Workbook wb = new Workbook("shortenerDemo.xlsx", "Sheet1"); // Create a workbook (important: A worksheet must be created as well) 
+            wb.WS.Value("Some Text");                                   // Add cell A1
+            wb.WS.Value(58.55, Style.BasicStyles.DoubleUnderline);      // Add a formated value to cell B1
+            wb.WS.Right(2);                                             // Move to cell E1   
+            wb.WS.Value(true);                                          // Add cell E1
+            wb.AddWorksheet("Sheet2");                                  // Add a new worksheet
+            wb.CurrentWorksheet.CurrentCellDirection = Worksheet.CellDirection.RowToRow;    // Change the cell direction
+            wb.WS.Value("This is another text");                        // Add cell A1
+            wb.WS.Formula("=A1");                                       // Add a formula in Cell A2
+            wb.WS.Down();                                               // Go to cell A4
+            wb.WS.Value("Formated Text", Style.BasicStyles.Bold);       // Add a formated value to cell A4
+            wb.Save();                                                  // Save the workbook
+        }
+
         /// <summary>
         /// This method shows how to save a workbook as stream 
         /// </summary>

Executable/Debug/PicoXLSX.XML

@@ -6,8 +6,8 @@
 // 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 ("PicoXLSX")]
-[assembly: AssemblyDescription ("PicoXLSX is a library to generate XLSX files in an easy and native way")]
+[assembly: AssemblyTitle ("PicoXLSX")]
+[assembly: AssemblyDescription("PicoXLSX is a library to generate Microsoft Excel files (XLSX) in an easy and native way")]
 [assembly: AssemblyConfiguration ("")]
 [assembly: AssemblyCompany("Raphael Stoeckli")]
 [assembly: AssemblyProduct ("PicoXLSX")]
@@ -29,6 +29,6 @@
 //
 // 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.1.1")]
-[assembly: AssemblyFileVersion("2.1.1")]
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("2.2.0")]
+[assembly: AssemblyFileVersion("2.2.0")]

Executable/Debug/PicoXLSX.dll

@@ -35,9 +35,21 @@ public class Workbook
         private bool lockWindowsIfProtected;
         private bool lockStructureIfProtected;
         private int selectedWorksheet;
+        private Shortener shortener;
 #endregion
 
 #region properties
+
+
+        /// <summary>
+        /// Shortener object for the current worksheet
+        /// </summary>
+        public Shortener WS
+        {
+            get { return shortener; }
+        }
+        
+
         /// <summary>
         /// Gets the current worksheet
         /// </summary>
@@ -230,6 +242,7 @@ public void AddWorksheet(string name)
             Worksheet newWs = new Worksheet(name, number, this);
             this.currentWorksheet = newWs;
             this.worksheets.Add(newWs);
+            this.shortener.SetCurrentWorksheet(this.currentWorksheet);
         }
 
         /// <summary>
@@ -287,6 +300,7 @@ private void Init()
             borderStyle.CurrentFill = Style.BasicStyles.DottedFill_0_125.CurrentFill;
             this.styleManager.AddStyle(borderStyle);
             this.workbookMetadata = new Metadata();
+            this.shortener = new Shortener();
         }
 
 
@@ -590,5 +604,130 @@ public void SetSelectedWorksheet(Worksheet worksheet)
         }
 
 #endregion
+
+#region sub-classes
+
+/// <summary>
+/// Class to provide access to the current worksheet with a shortened syntax
+/// </summary>
+public class Shortener
+{
+    private Worksheet currentWorksheet;
+
+    /// <summary>
+    /// Default constructor
+    /// </summary>
+    public Shortener()
+    { }
+
+    /// <summary>
+    /// Sets the worksheet accessed by the shortener
+    /// </summary>
+    /// <param name="worksheet"></param>
+    public void SetCurrentWorksheet(Worksheet worksheet)
+    {
+        this.currentWorksheet = worksheet;
+    }
+
+    /// <summary>
+    /// Sets a value into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
+    /// </summary>
+    /// <exception cref="WorksheetException">Throws a WorksheetException if no worksheet was defined</exception>
+    /// <param name="value">Value to set</param>
+    public void Value(object value)
+    {
+        NullCheck();
+        this.currentWorksheet.AddNextCell(value);
+    }
+
+    /// <summary>
+    /// Sets a value with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
+    /// </summary>
+    /// <exception cref="WorksheetException">Throws a WorksheetException if no worksheet was defined</exception>
+    /// <param name="value">Value to set</param>
+    /// <param name="style">Style to apply</param>
+    public void Value(object value, Style style)
+    {
+        NullCheck();
+        this.currentWorksheet.AddNextCell(value, style);
+    }
+
+    /// <summary>
+    /// Sets a formula into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
+    /// </summary>
+    /// <exception cref="WorksheetException">Throws a WorksheetException if no worksheet was defined</exception>
+    /// <param name="formula">Formula to set</param>
+    public void Formula(string formula)
+    {
+        NullCheck();
+        this.currentWorksheet.AddNextCellFormula(formula);
+    }
+
+    /// <summary>
+    /// Sets a formula with style into the current cell and moves the cursor to the next cell (column or row depending on the defined cell direction)
+    /// </summary>
+    /// <exception cref="WorksheetException">Throws a WorksheetException if no worksheet was defined</exception>
+    /// <param name="formula">Formula to set</param>
+    /// <param name="style">Style to apply</param>
+    public void Formula(string formula, Style style)
+    {
+        NullCheck();
+        this.currentWorksheet.AddNextCellFormula(formula, style);
+    }
+
+    /// <summary>
+    /// Moves the cursor one row down
+    /// </summary>
+    public void Down()
+    {
+        NullCheck();
+        this.currentWorksheet.GoToNextRow();
+    }
+
+    /// <summary>
+    /// Moves the cursor the number of defined rows down
+    /// </summary>
+    /// <param name="numberOfRows">Number of rows to move</param>
+    public void Down(int numberOfRows)
+    {
+        NullCheck();
+        this.currentWorksheet.GoToNextRow(numberOfRows);
+    }
+
+    /// <summary>
+    /// Moves the cursor one column to the right
+    /// </summary>
+    public void Right()
+    {
+        NullCheck();
+        this.currentWorksheet.GoToNextColumn();
+    }
+
+    /// <summary>
+    /// Moves the cursor the number of defined columns to the right
+    /// </summary>
+    /// <param name="numberOfColumns">Number of columns to move</param>
+    public void Right(int numberOfColumns)
+    {
+        NullCheck();
+        this.currentWorksheet.GoToNextColumn(numberOfColumns);
+    }
+
+    /// <summary>
+    /// Internal method to check whether the worksheet is null
+    /// </summary>
+    private void NullCheck()
+    {
+        if (this.currentWorksheet == null)
+        {
+            throw new WorksheetException("UndefinedWorksheetException", "No worksheet was defined");
+        }
+    }
+
+
+}
+
+#endregion
+
     }
 }

Executable/Documentation.chm

@@ -2,7 +2,7 @@
 ![PicoXLSX](https://rabanti-github.github.io/PicoXLSX/icons/PicoXLSX.png)
 
 
-PicoXLSX is a small .NET / C# library to create XLSX files (Microsoft Excel 2007 or newer) in an easy and native way
+PicoXLSX is a small .NET library written in C#, to create Microsoft Excel files in the XLSX format (Microsoft Excel 2007 or newer) in an easy and native way
 * **No dependencies** (\*
  * No need for an installation of Microsoft Office
  * No need for Office interop libraries
@@ -44,7 +44,17 @@ Simply place the PicoXLSX DLL into your .NET project and add a reference (in VS
 Place all .CS files from the PicoXLSX source folder into your project. You can place them into a sub-folder if you wish. The files contains definitions for workbooks, worksheets, cells, styles, meta-data, low level methods and exceptions.
 
 # Usage
-## Quick Start
+## Quick Start (shortened syntax)
+```
+ Workbook workbook = new Workbook("myWorkbook.xlsx", "Sheet1");         // Create new workbook with a worksheet called Sheet1
+ workbook.WS.Value("Some Data");                                        // Add cell A1
+ workbook.WS.Formula("=A1");                                            // Add formula to cell B1
+ workbook.WS.Down();                                                    // Go to row 2
+ workbook.WS.Value(DateTime.Now, Style.BasicStyles.Bold);               // Add formated value to cell A2
+ workbook.Save();                                                       // Save the workbook as myWorkbook.xlsx
+```
+
+## Quick Start (regular syntax)
 ```
  Workbook workbook = new Workbook("myWorkbook.xlsx", "Sheet1");         // Create new workbook with a worksheet called Sheet1
  workbook.CurrentWorksheet.AddNextCell("Some Data");                    // Add cell A1
@@ -58,6 +68,6 @@ Place all .CS files from the PicoXLSX source folder into your project. You can p
 See the full **API-Documentation** at: [https://rabanti-github.github.io/PicoXLSX/](https://rabanti-github.github.io/PicoXLSX/).
 
 
-The [Demo project](https://github.com/rabanti-github/PicoXLSX/tree/master/Demo) contains ten simple use cases. You can find also the full documentation in the [Documentation-Folder](https://github.com/rabanti-github/PicoXLSX/tree/master/Documentation) or as C# documentation in the .CS files.
+The [Demo project](https://github.com/rabanti-github/PicoXLSX/tree/master/Demo) contains eleven simple use cases. You can find also the full documentation in the [Documentation-Folder](https://github.com/rabanti-github/PicoXLSX/tree/master/Documentation) or as C# documentation in the .CS files.
 
 See also: [Getting started in the Wiki](https://github.com/rabanti-github/PicoXLSX/wiki/Getting-started)