README.md file added

Author: Fahad Adeel

.DS_Store

@@ -49,7 +49,7 @@ public void setNumberDataType()
         /// <summary>
         /// This method is used to set the value of a Cell.
         /// </summary>
-        ///   /// <param name="value">A dynamic value.</param>
+        /// <param name="value">A dynamic value.</param>
         public void CellValue(dynamic value)
         {
             this.cell.CellValue = new DocumentFormat.OpenXml.Spreadsheet.CellValue(value);
@@ -58,7 +58,6 @@ public void CellValue(dynamic value)
         /// <summary>
         /// Sets the style index of the cell to 1.
         /// </summary>
-        /// 
         public void CellIndex()
         {
             this.cell.StyleIndex = 1;
@@ -67,7 +66,7 @@ public void CellIndex()
         /// <summary>
         /// Sets the style index of the cell to the specified value.
         /// </summary>
-        /// <param name="num">The style index to be set for the cell.</param>
+        /// <param name="num">The style index is to be set for the cell.</param>
 
         public void CellIndex(UInt32Value num)
         {

FileFormat.Cells/Cell.cs

@@ -1,4 +1,4 @@
-using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
 
 using A = DocumentFormat.OpenXml.Drawing;
@@ -10,7 +10,7 @@
 namespace FileFormat.Cells.Image
 {
     /// <summary>
-    /// This class contains methods to add images into an Excel document.
+    /// This class contains methods to add images to an Excel document.
     /// </summary>
     public class Image
     {
@@ -47,9 +47,10 @@ public Image(Workbook workbook)
         /// </summary>
         /// <param name="sheetIndex">An integer value represents the index of worksheet.</param>
         ///  <param name="imagePath">An integer value represents the index of worksheet.</param>
-        ///  <param name="startRowIndex">An integer value.</param>
-        ///  <param name="endRowIndex">An integer value.</param>
-        ///  <param name="endColumnIndex">An integer value</param>
+        ///  <param name="startRowIndex">An integer value that represents the starting row index.</param>
+        ///  <param name="startColumnIndex">An integer value that represents the starting column index.</param>
+        ///  <param name="endRowIndex">An integer value that represents the ending row index.</param>
+        ///  <param name="endColumnIndex">An integer value that represents the ending column index.</param>
 
         public void Add(int sheetIndex, string imagePath, int startRowIndex, int startColumnIndex, int endRowIndex, int endColumnIndex) {
 
@@ -401,7 +402,7 @@ private void GenerateDrawingsPart(int sheetIndex, DrawingsPart drawingsPart1, in
         /// Invoke this method to read the value of a particular cell. 
         /// </summary>
         /// <param name="sheetIndex">An Integer value.</param>
-
+        /// <returns>A collection of image streams.</returns>
         public List<Stream> ExtractImagesFromWorkSheet(int sheetIndex)
         {
             List<Stream> imagePartsCollection = new List<Stream>();
@@ -417,7 +418,7 @@ public List<Stream> ExtractImagesFromWorkSheet(int sheetIndex)
         /// <summary>
         /// Call this property to get the total number of images in a Workbook.
         /// </summary>
-
+        /// <returns>The count of the total number of images in a Workbook. </returns>
         public int GetImagesCountFromWorkBook
         {
             get

FileFormat.Cells/Image.cs

@@ -8,7 +8,7 @@ public class BuiltInDocumentProperties
     {
 
         /// <summary>
-        /// This property is used to get/set the Author name of a Word document.
+        /// This property is used to get/set the Author name of an Excel document.
         /// </summary>
         /// <returns>Returns a string value.</returns>
         public String Author { get; set; }

FileFormat.Cells/Properties.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.IO.Packaging;
 using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
@@ -18,16 +18,18 @@ public class Workbook : IDisposable
         protected internal DocumentFormat.OpenXml.Packaging.SpreadsheetDocument spreadsheetDocument;
         /// <value>
         /// An object of the Parent WorkbookPart class.
-        /// </value>
+        /// </value>
         protected internal DocumentFormat.OpenXml.Packaging.WorkbookPart workbookpart;
         /// <value>
         /// An object of the Parent worksheetPart class.
-        /// </value>
-        protected internal DocumentFormat.OpenXml.Packaging.WorksheetPart worksheetPart;
-
-        protected internal WorkbookStylesPart stylesPart;
-
-        private MemoryStream ms;
+        /// </value>
+        protected internal DocumentFormat.OpenXml.Packaging.WorksheetPart worksheetPart;
+        /// <value>
+        /// An object of the Parent WorkbookStylesPart class.
+        /// </value>
+        protected internal WorkbookStylesPart stylesPart;
+
+        private MemoryStream ms;
         private bool disposedValue;
 
         /// <summary>
@@ -44,7 +46,7 @@ public Workbook()
             this.worksheetPart = this.workbookpart.AddNewPart<WorksheetPart>();
             this.worksheetPart.Worksheet = new DocumentFormat.OpenXml.Spreadsheet.Worksheet();
 
-            this.stylesPart = this.spreadsheetDocument.WorkbookPart.AddNewPart<WorkbookStylesPart>();
+            this.stylesPart = this.spreadsheetDocument.WorkbookPart.AddNewPart<WorkbookStylesPart>();
             this.stylesPart.Stylesheet = new Stylesheet();
 
 
@@ -55,10 +57,10 @@ public Workbook()
 
         }
 
-        // <summary>
+        /// <summary>
         /// Applies the specified font style to the workbook.
         /// </summary>
-        /// <param name="fontName">The name of the font to be applied.</param>
+        /// <param name='fontName'>The name of the font to be applied.</param>
         /// <param name="fontSize">The size of the font to be applied.</param>
 
         public void ApplyFontStyle(string fontName, int fontSize)
@@ -79,12 +81,10 @@ public void ApplyFontStyle(string fontName, int fontSize)
             // Add the font to the Fonts collection in the Stylesheet
             stylesPart.Stylesheet.Fonts = new Fonts();
             stylesPart.Stylesheet.Fonts.AppendChild(font);
-
 
         }
 
 
-
         /// <summary>
         /// Create an object of the Workbook class that opens an existing Excel document from a file.
         /// </summary>
@@ -146,7 +146,7 @@ public void Save(string filePath)
         }
 
         /// <summary>
-        /// Invoke this method to save the document to a file. 
+        /// Invoke this method to save the document to a stream. 
         /// </summary>
         /// <param name="stream">An object of the Stream class.</param>
         public void Save(Stream stream)
@@ -174,6 +174,7 @@ public int Worksheets
         /// Invoke this method to delete a worksheet from an Excel document. 
         /// </summary>
         /// <param name="sheetName">String value represents the worksheet name.</param>
+        /// <returns>A string value. </returns>
         public string DeleteWorksheet(string sheetName)
         {
             try
@@ -214,6 +215,7 @@ public string DeleteWorksheet(string sheetName)
         /// </summary>
         /// <param name="sheetName">String value represents the worksheet name.</param>
         /// <param name="cellRef">String value represents the address of the cell.</param>
+        /// <returns>A sttring value. </returns>
         public string GetCellValue(string sheetName, string cellRef)
         {
 
@@ -236,7 +238,7 @@ public string GetCellValue(string sheetName, string cellRef)
         /// This method removes a cell's value in a Worksheet.
         /// </summary>
         /// <param name="sheetName">String value represents the worksheet name.</param>
-        /// <param name="colName">String value represents the name of the column.</param>
+        /// <param name="colName">The string value represents the name of the column.</param>
         /// <param name="rowIndex">An integer value represents the row.</param>
         public void DeleteTextFromCell(string sheetName, string colName, uint rowIndex)
         {
@@ -284,6 +286,7 @@ private DocumentFormat.OpenXml.Spreadsheet.Cell GetSpreadsheetCell(DocumentForma
         /// <summary>
         /// It returns custom built-in document properties.
         /// </summary>
+        /// <returns>An object of document properties. </returns>
         public BuiltInDocumentProperties BuiltinDocumentProperties
         {
             get

FileFormat.Cells/Workbook.cs

@@ -1,6 +1,6 @@
-using System.Linq;
+using System.Linq;
 using System.Text.RegularExpressions;
-using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml;
 using DocumentFormat.OpenXml.Packaging;
 using DocumentFormat.OpenXml.Spreadsheet;
 
@@ -34,10 +34,17 @@ public class Worksheet
         private UInt32 sheetID;
         private string ID;
         SheetData sheetData;
+        /// <value>
+        /// An object of the Parent WorkbookStylesPart class.
+        /// </value>
         protected internal WorkbookStylesPart stylesPart;
-
+        /// <value>
+        /// An object of the Parent MergeCells class.
+        /// </value>
         protected internal MergeCells mergeCells;
-
+        /// <value>
+        /// An object of the Parent Stylesheet class.
+        /// </value>
         protected internal Stylesheet stylesheet;
         int i = 1;
 
@@ -210,9 +217,9 @@ private static List<UInt32> AddStyle(ref Stylesheet stylesheet)
         }
 
         /// <summary>
-        /// Inserts a new cell style into the spreadsheet's styles part.
+        /// Insert a new cell style into the spreadsheet's styles part.
         /// </summary>
-        /// <param name="cellStyle">The <see cref="CellStyle"/> containing the desired font family, size, and cell color.</param>
+        /// <param name="cellStyle">The <see cref="CellStyle"/> contains the desired font family, size, and cell color.</param>
         /// <returns>The index of the inserted style within the stylesheet's cell formats.</returns>
 
 
@@ -294,7 +301,12 @@ private static uint GetRowIndex(string cellName)
         }
 
 
-        // Merge two cells by range (e.g., "A1" to "B2")
+        
+        /// <summary>
+        /// Merge two cells by range (e.g., "A1" to "B2")
+        /// </summary>
+        /// <param name="startCellRef">A string value.</param>
+        /// <param name="endCellRef">A string value.</param>
         public void MergeCells(string startCellRef, string endCellRef)
         {
 

FileFormat.Cells/Worksheet.cs

@@ -0,0 +1,64 @@
+# Open-Source .NET API For Excel Automation
+
+<p> <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> is an <b>open-source .NET library</b> developed to automate Spreadsheet creation and management. This is an extensible C# library for Workbook management and modification. Regardless of the user's expertise, this <b>Spreadsheet API</b> is easy to install and use. In addition, the robustness of this API is due to <a href="https://learn.microsoft.com/en-us/office/open-xml/word-processing">OpenXML</a> which is the core engine of FileFormat.Cells. However, you may install this C# library to achieve Excel file generation and manipulation programmatically. Once this library is set up, you need no third-party library to automate Spreadsheet creation or modification.
+</p>
+<p align="center" dir="auto">
+  <a title="Download ZIP" href="https://github.com/fileformat-cells/FileFormat.Cells-for-.NET/archive/master.zip">
+    <img src="https://camo.githubusercontent.com/594ea6cc6161dd6c3f7bc55c9022c27b94fe39c74bc90a9a8d144c77b9af1573/687474703a2f2f692e696d6775722e636f6d2f68774e6872475a2e706e67" data-canonical-src="http://i.imgur.com/hwNhrGZ.png" style="max-width: 100%;">
+  </a>
+</p>
+
+## About this Repo
+
+<table>
+  <tr>
+    <th>Directory</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td><a href = "https://github.com/fileformat-cells/FileFormat.Cells-for-.NET/tree/main/FileFormat.Cells_Tests">FileFormat.Cells_Tests</a></td>
+    <td>This directory contains the unit tests of all the features FileFormat.Cells offers.</td>
+  </tr>
+  <tr>
+    <td><a href = "https://github.com/fileformat-cells/FileFormat.Cells-for-.NET/tree/main/FileFormat.Cells">FileFormat.Cells</a></td>
+    <td>It contains all the source code files necessary to execute the features.</td>
+  </tr>
+  <tr>
+    <td><a href = "https://github.com/fileformat-cells/FileFormat.Cells-for-.NET/tree/main/TestSpreadSheets">TestSpreadSheets</a></td>
+    <td>This folder includes test files generated by this Open-Souorce .NET API.</td>
+  </tr>
+</table>
+
+## Library Features & Provisions
+
+<p> <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> provides seamless Spreadsheet creation and manipulation. Moreover, this Spreadsheet API lets users design Excel files programmatically as per data representation needs. </p>
+
+This Open-Source .NET API comes up with the following functionalities:
+
+ - <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> API provides empty Excel file creation as well as with the content. Moreover, .NET developers can
+   open existing Excel files from a file & stream both.
+ - This .NET Spreadsheet API offers methods and properties to create/delete Worksheets. Further, users can insert/delete data into cells and read rows/columns programmatically.
+ - There are methods and properties to update the Font family and Font size of the data in Cells.  
+ - Users can leverage the <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/api/FileFormat.Cells.Image.Image.html">Image</a> namespace to add images to Worksheets. In addition, there are properties and functions to extract images from Worksheets.
+
+
+## Getting Started With FileFormat.Words For .NET
+
+<p>Since FileFormat.Cells is available as a <a href="#">NuGet Package</a>, you can download the Nuget Package of this library. Well, the installation procedure of this C# Spreadsheet API is a matter of running a single command as mentioned below:  </p>
+<code>Install-Package FileFormat.Cells</code>
+
+## Creating a Word Document Programmatically
+
+The following code segment creates an empty <a href="https://docs.fileformat.com/spreadsheet/xlsx/">Excel<a/> file with a default Worksheet. 
+<pre>
+<code>
+// Create an object of the Workbook class.
+ Workbook workbook = new Workbook();
+
+// Call the Save method to save the Excel file onto the disk.
+workbook.Save("/spreadsheet.xlsx");
+</code>
+</pre>
+
+## Coming updates
+<p> <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> is planning to add more functionalities to its features bucket. However, after the successful launch of <a href="https://fileformat-cells.github.io/FileFormat.Cells-for-.NET/">FileFormat.Cells</a> and <a href="https://fileformat-words.github.io/FileFormat.Words-for-.NET/">FileFormat.Words</a> the development of FileFormat.Slides is a work in progress. So, stay in touch for regular updates. </p>