Merge branch 'dev'

Author: rabanti-github

Changelog.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## v3.2.0
+
+---
+Release Date: **07.09.2023**
+
+- Added worksheet option for zoom factors
+- Added worksheet option for view types (e.g. page break preview)
+- Added worksheet option to show or hide grid lines
+- Added worksheet option to show or hide columns and row headers
+- Added worksheet option to show or hide rulers in page layout view type 
+
+
 ## v3.1.1
 
 ---

Demo .NET Standard/Demo .NET Standard.csproj

@@ -8,9 +8,9 @@
     <Copyright>Copyright Raphael Stoeckli © 2023</Copyright>
     <RepositoryUrl>https://github.com/rabanti-github/PicoXLSX.git</RepositoryUrl>
     <PackageProjectUrl>https://github.com/rabanti-github/PicoXLSX</PackageProjectUrl>
-    <AssemblyVersion>3.1.1.0</AssemblyVersion>
-    <FileVersion>3.1.1.0</FileVersion>
-    <Version>3.1.1</Version>
+    <AssemblyVersion>3.2.0.0</AssemblyVersion>
+    <FileVersion>3.2.0.0</FileVersion>
+    <Version>3.2.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>

Demo/Properties/AssemblyInfo.cs

@@ -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("3.1.1.0")]
-[assembly: AssemblyFileVersion("3.1.1.0")]
+[assembly: AssemblyVersion("3.2.0.0")]
+[assembly: AssemblyFileVersion("3.2.0.0")]

PicoXLSX .NET Standard/PicoXLSX .NET Standard.csproj

@@ -4,7 +4,7 @@
     <TargetFrameworks>netstandard2.0;net45</TargetFrameworks>
     <RootNamespace>PicoXLSX</RootNamespace>
     <PackageId>PicoXLSX</PackageId>
-    <Version>3.1.1</Version>
+    <Version>3.2.0</Version>
     <Authors>Raphael Stoeckli</Authors>
     <Company></Company>
     <Product>PicoXLSX</Product>
@@ -17,8 +17,8 @@
     <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>3.1.1.0</AssemblyVersion>
-    <FileVersion>3.1.1.0</FileVersion>
+    <AssemblyVersion>3.2.0.0</AssemblyVersion>
+    <FileVersion>3.2.0.0</FileVersion>
     <AssemblyName>PicoXLSX</AssemblyName>
     <ApplicationIcon>favicon.ico</ApplicationIcon>
   </PropertyGroup>

PicoXLSX/LowLevel.cs

@@ -386,7 +386,8 @@ private string CreateWorksheetPart(Worksheet worksheet)
             {
                 sb.Append("<dimension ref=\"").Append(new Cell.Range(worksheet.GetFirstCellAddress().Value, worksheet.GetLastCellAddress().Value)).Append("\"/>");
             }
-            if (worksheet.SelectedCellRanges.Count > 0 || worksheet.PaneSplitTopHeight != null || worksheet.PaneSplitLeftWidth != null || worksheet.PaneSplitAddress != null || worksheet.Hidden)
+            if (worksheet.SelectedCellRanges.Count > 0 || worksheet.PaneSplitTopHeight != null || worksheet.PaneSplitLeftWidth != null || worksheet.PaneSplitAddress != null ||
+                worksheet.Hidden || worksheet.ZoomFactor != 100 || worksheet.ZoomFactors.Count > 1 || !worksheet.ShowGridLines || !worksheet.ShowRuler || !worksheet.ShowRowColumnHeaders || worksheet.ViewType != Worksheet.SheetViewType.normal)
             {
                 CreateSheetViewString(worksheet, sb);
             }
@@ -467,6 +468,54 @@ private void CreateSheetViewString(Worksheet worksheet, StringBuilder sb)
             {
                 sb.Append(" tabSelected=\"1\"");
             }
+            if (worksheet.ViewType != Worksheet.SheetViewType.normal)
+            {
+                if (worksheet.ViewType == Worksheet.SheetViewType.pageLayout)
+                {
+                    if (worksheet.ShowRuler)
+                    {
+                        sb.Append(" showRuler=\"1\"");
+                    }
+                    else
+                    {
+                        sb.Append(" showRuler=\"0\"");
+                    }
+                    sb.Append(" view=\"pageLayout\"");
+                    
+                }
+                else if (worksheet.ViewType == Worksheet.SheetViewType.pageBreakPreview)
+                {
+                    sb.Append(" view=\"pageBreakPreview\"");
+                }
+            }
+            if (!worksheet.ShowGridLines)
+            {
+                sb.Append(" showGridLines=\"0\"");
+            }
+            if (!worksheet.ShowRowColumnHeaders)
+            {
+                sb.Append("  showRowColHeaders=\"0\"");
+            }
+            sb.Append(" zoomScale=\"").Append(worksheet.ZoomFactor.ToString("G", culture)).Append("\"");
+            foreach(KeyValuePair<Worksheet.SheetViewType, int> scaleFactor in worksheet.ZoomFactors)
+            {
+                if (scaleFactor.Key == worksheet.ViewType)
+                {
+                    continue;
+                }
+                if (scaleFactor.Key == Worksheet.SheetViewType.normal)
+                {
+                    sb.Append(" zoomScaleNormal=\"").Append(scaleFactor.Value.ToString("G", culture)).Append("\"");
+                }
+                else if (scaleFactor.Key == Worksheet.SheetViewType.pageBreakPreview)
+                {
+                    sb.Append(" zoomScaleSheetLayoutView=\"").Append(scaleFactor.Value.ToString("G", culture)).Append("\"");
+                }
+                else if (scaleFactor.Key == Worksheet.SheetViewType.pageLayout)
+                {
+                    sb.Append(" zoomScalePageLayoutView=\"").Append(scaleFactor.Value.ToString("G", culture)).Append("\"");
+                }
+            }
             sb.Append(">");
             CreatePaneString(worksheet, sb);
             if (worksheet.SelectedCells != null)

PicoXLSX/Properties/AssemblyInfo.cs

@@ -30,5 +30,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("3.1.1")]
-[assembly: AssemblyFileVersion("3.1.1")]
+[assembly: AssemblyVersion("3.2.0")]
+[assembly: AssemblyFileVersion("3.2.0")]

PicoXLSX/Workbook.cs

@@ -983,7 +983,8 @@ public void Up()
             /// Moves the cursor the number of defined rows up
             /// </summary>
             /// <param name="numberOfRows">Number of rows to move.</param>
-            /// <param name="keepColumnPosition">If true, the column position is preserved, otherwise set to 0.</param>
+            /// <param name="keepColumnPosition">If true, the column position is preserved, otherwise set to 0</param>
+            /// <remarks>An exception will be thrown if the row number is below 0. Values (number of rows) can be also negative. However, this is the equivalent of the function <see cref="Down(int, bool)"/></remarks>
             public void Up(int numberOfRows, bool keepColumnPosition = false)
             {
                 NullCheck();

PicoXLSX/Worksheet.cs

@@ -80,6 +80,21 @@ public class Worksheet
         /// </summary>
         public const float MAX_ROW_HEIGHT = 409.5f;
 
+        /// <summary>
+        /// Automatic zoom factor of a worksheet
+        /// </summary>
+        public const int AUTO_ZOOM_FACTOR = 0;
+
+        /// <summary>
+        /// Minimum zoom factor of a worksheet
+        /// </summary>
+        public const int MIN_ZOOM_FACTOR = 10;
+
+        /// <summary>
+        /// Maximum zoom factor of a worksheet
+        /// </summary>
+        public const int MAX_ZOOM_FACTOR = 400;
+
         /// <summary>
         /// Enum to define the direction when using AddNextCell method
         /// </summary>
@@ -146,6 +161,19 @@ public enum WorksheetPane
             topLeft
         }
 
+        /// <summary>
+        /// Enum to define how a worksheet is displayed in the spreadsheet application (Excel)
+        /// </summary>
+        public enum SheetViewType
+        {
+            /// <summary>The worksheet is displayed without pagination (default)</summary>
+            normal,
+            /// <summary>The worksheet is displayed with indicators where the page would break if it were printed</summary>
+            pageBreakPreview,
+            /// <summary>The worksheet is displayed like it would be printed</summary>
+            pageLayout
+        }
+
         /// <summary>
         /// Defines the activeStyle
         /// </summary>
@@ -276,6 +304,16 @@ public enum WorksheetPane
         /// </summary>
         private int sheetID;
 
+        /// <summary>
+        /// Defines how the current worksheet is displayed in the spreadsheet application (Excel)
+        /// </summary>
+        private SheetViewType viewType;
+
+        /// <summary>
+        /// Defines the zoom factors of the current worksheet for each view type
+        /// </summary>
+        private Dictionary<SheetViewType, int> zoomFactor;
+
         /// <summary>
         /// Gets the range of the auto-filter. Wrapped to Nullable to provide null as value. If null, no auto-filter is applied
         /// </summary>
@@ -548,6 +586,66 @@ public Style ActiveStyle
             get { return activeStyle; }
         }
 
+        /// <summary>
+        /// Gets or sets whether grid lines are visible on the current worksheet. Default is true
+        /// </summary>
+        public bool ShowGridLines { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether the column and row headers are visible on the current worksheet. Default is true
+        /// </summary>
+        public bool ShowRowColumnHeaders { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether a ruler is displayed over the column headers. This value only applies if <see cref="ViewType"/> is set to <see cref="SheetViewType.pageLayout"/>. Default is true
+        /// </summary>
+        public bool ShowRuler { get; set; }
+
+        /// <summary>
+        /// Gets or sets how the current worksheet is displayed in the spreadsheet application (Excel)
+        /// </summary>
+        public SheetViewType ViewType
+        {
+            get
+            {
+                return viewType;
+            }
+            set
+            {
+                viewType = value;
+                SetZoomFactor(value, 100);
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the zoom factor of the <see cref="ViewType"/> of the current worksheet. If <see cref="AUTO_ZOOM_FACTOR"/>, the zoom factor is set to automatic
+        /// </summary>
+        /// <remarks>It is possible to add further zoom factors for inactive view types, using the function <see cref="SetZoomFactor(SheetViewType, int)"/> </remarks>
+        /// <exception cref="WorksheetException">Throws a WorksheetException if the zoom factor is not <see cref="AUTO_ZOOM_FACTOR"/> or below <see cref="MIN_ZOOM_FACTOR"/> or above <see cref="MAX_ZOOM_FACTOR"/></exception>
+        public int ZoomFactor
+        {
+            set
+            {
+                SetZoomFactor(viewType, value);
+            }
+            get
+            {
+                return zoomFactor[viewType];
+            }
+        }
+
+        /// <summary>
+        /// Gets all defined zoom factors per <see cref="SheetViewType"/> of the current worksheet. Use <see cref="SetZoomFactor(SheetViewType, int)"/> to define the values
+        /// </summary>
+        public Dictionary<SheetViewType, int> ZoomFactors
+        {
+            get
+            {
+                return zoomFactor;
+            }
+        }
+
+
         /// <summary>
         /// Initializes a new instance of the <see cref="Worksheet"/> class
         /// </summary>
@@ -567,6 +665,12 @@ public Worksheet()
             selectedCells = new List<Range>();
             activeStyle = null;
             workbookReference = null;
+            viewType = SheetViewType.normal;
+            zoomFactor = new Dictionary<SheetViewType, int>();
+            zoomFactor.Add(viewType, 100);
+            ShowGridLines = true;
+            ShowRowColumnHeaders = true;
+            ShowRuler = true;
         }
 
         /// <summary>
@@ -2210,6 +2314,15 @@ public Worksheet Copy()
             }
             copy.useActiveStyle = this.useActiveStyle;
             copy.UseSheetProtection = this.UseSheetProtection;
+            copy.ShowGridLines = this.ShowGridLines;
+            copy.ShowRowColumnHeaders = this.ShowRowColumnHeaders;
+            copy.ShowRuler = this.ShowRuler;
+            copy.ViewType = this.ViewType;
+            copy.zoomFactor.Clear();
+            foreach(KeyValuePair<SheetViewType, int> zoomFactor in this.zoomFactor)
+            {
+                copy.SetZoomFactor(zoomFactor.Key, zoomFactor.Value);
+            }
             return copy;
         }
 
@@ -2241,6 +2354,29 @@ public static string SanitizeWorksheetName(string input, Workbook workbook)
             return GetUnusedWorksheetName(sb.ToString(), workbook);
         }
 
+        /// <summary>
+        /// Sets a zoom factor for a given <see cref="SheetViewType"/>. If <see cref="AUTO_ZOOM_FACTOR"/>, the zoom factor is set to automatic
+        /// </summary>
+        /// <param name="sheetViewType">Sheet view type to apply the zoom factor on</param>
+        /// <param name="zoomFactor">Zoom factor in percent</param>
+        /// <remarks>This factor is not the currently set factor. use the property <see cref="ZoomFactor"/> to set the factor for the current <see cref="ViewType"/></remarks>
+        /// <exception cref="WorksheetException">Throws a WorksheetException if the zoom factor is not <see cref="AUTO_ZOOM_FACTOR"/> or below <see cref="MIN_ZOOM_FACTOR"/> or above <see cref="MAX_ZOOM_FACTOR"/></exception>
+        public void SetZoomFactor(SheetViewType sheetViewType, int zoomFactor)
+        {
+            if (zoomFactor != AUTO_ZOOM_FACTOR && (zoomFactor < MIN_ZOOM_FACTOR || MAX_ZOOM_FACTOR > 400))
+            {
+                throw new WorksheetException("The zoom factor " + zoomFactor + " is not valid. Valid are values between " + MIN_ZOOM_FACTOR + " and " + MAX_ZOOM_FACTOR + ", or " + AUTO_ZOOM_FACTOR + " (automatic)");
+            }
+            if (this.zoomFactor.ContainsKey(sheetViewType))
+            {
+                this.zoomFactor[sheetViewType] = zoomFactor;
+            }
+            else
+            {
+                this.zoomFactor.Add(sheetViewType, zoomFactor);
+            }
+        }
+
         /// <summary>
         /// Determines the next unused worksheet name in the passed workbook
         /// </summary>