Merge pull request #51 from piwonesien/feature/hide-worksheet

Ability to hide a worksheet
salvois · Jul 21, 2024 · 2213bbd · 2213bbd
2 parents ef9742b + 3a03777
commit 2213bbd
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -182,6 +182,7 @@ Call `BeginWorksheet` passing the sheet name and one or more of the following op
 - `columns`: pass a non-`null` list to specify optional column formatting (see below)
 - `showGridLines`: set to `false` to hide gridlines in the sheet
 - `showHeaders`: set to `false` to hide row and column headers in the sheet
+- `visibleType`: set workspace visibility, possible are: `visible`, `hidden` and `veryHidden`
 
 ```csharp
 // class XlsxWriter
@@ -192,7 +193,8 @@ public XlsxWriter BeginWorksheet(
         bool rightToLeft = false, // rightToLeft since version 1.2
         IEnumerable<XlsxColumn> columns = null,
         bool showGridLines = true, // showGridLines since version 1.8
-        bool showHeaders = true); // showHeaders since version 1.8
+        bool showHeaders = true,  // showHeaders since version 1.8
+        Visibility visibleType = Visibility.Visible);
 ```
 
 Note that, for compatibility with a restriction of the Excel application, names are restricted to a maximum of 31 character. An `ArgumentException` is thrown if a longer name is passed.

diff --git a/examples/Examples/HideWorksheet.cs b/examples/Examples/HideWorksheet.cs
@@ -0,0 +1,54 @@
+/*
+LargeXlsx - Minimalistic .net library to write large XLSX files
+
+Copyright 2020-2024 Salvatore ISAJA. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+using System.Drawing;
+using System.IO;
+using LargeXlsx;
+
+namespace Examples;
+
+public static class HideWorksheet
+{
+    public static void Run()
+    {
+        var xlsxStyle = XlsxStyle.Default.With(XlsxBorder.Around(new XlsxBorder.Line(Color.Black, XlsxBorder.Style.Dotted)));
+        using var stream = new FileStream($"{nameof(HideWorksheet)}.xlsx", FileMode.Create, FileAccess.Write);
+        using var xlsxWriter = new XlsxWriter(stream);
+        xlsxWriter
+            .BeginWorksheet("VisibleWorksheet")
+            .BeginRow().Write("A1", xlsxStyle).Write("B1", xlsxStyle).Write("C1", xlsxStyle)
+            .BeginRow().Write("A2", xlsxStyle).Write("B2", xlsxStyle).Write("C2", xlsxStyle)
+            .BeginRow().Write("A3", xlsxStyle).Write("B3", xlsxStyle).Write("C3", xlsxStyle)
+            .BeginWorksheet("HiddenWorksheet", visibleType: Visibility.Hidden)
+            .BeginRow()
+            .BeginRow().Write("").Write("This sheet is hidden by default")
+            .BeginRow()
+            .BeginWorksheet("VeryHiddenWorksheet", visibleType: Visibility.VeryHidden)
+            .BeginRow()
+            .BeginRow().Write("").Write("This sheet is veryHidden by default")
+            .BeginRow();
+    }
+}
diff --git a/examples/Examples/Program.cs b/examples/Examples/Program.cs
@@ -36,6 +36,7 @@ public static void Main(string[] _)
         MultipleSheet.Run();
         FrozenPanes.Run();
         HideGridlines.Run();
+        HideWorksheet.Run();
         NumberFormats.Run();
         ColumnFormatting.Run();
         RowFormatting.Run();

diff --git a/src/LargeXlsx/Worksheet.cs b/src/LargeXlsx/Worksheet.cs
@@ -33,6 +33,13 @@ OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 
 namespace LargeXlsx
 {
+    public enum Visibility
+    {
+        Visible,
+        Hidden,
+        VeryHidden
+    }
+
     internal class Worksheet : IDisposable
     {
         private const int MinSheetProtectionPasswordLength = 1;
@@ -56,14 +63,16 @@ internal class Worksheet : IDisposable
         public string Name { get; }
         public int CurrentRowNumber { get; private set; }
         public int CurrentColumnNumber { get; private set; }
+        public Visibility VisibleType { get; private set; }
         internal string AutoFilterAbsoluteRef => _autoFilterAbsoluteRef;
 
-        public Worksheet(ZipWriter zipWriter, int id, string name, int splitRow, int splitColumn, bool rightToLeft, Stylesheet stylesheet, SharedStringTable sharedStringTable, IEnumerable<XlsxColumn> columns, bool showGridLines, bool showHeaders, bool requireCellReferences)
+        public Worksheet(ZipWriter zipWriter, int id, string name, int splitRow, int splitColumn, bool rightToLeft, Stylesheet stylesheet, SharedStringTable sharedStringTable, IEnumerable<XlsxColumn> columns, bool showGridLines, bool showHeaders, bool requireCellReferences, Visibility visibleType = Visibility.Visible)
         {
             Id = id;
             Name = name;
             CurrentRowNumber = 0;
             CurrentColumnNumber = 0;
+            VisibleType = visibleType;
             _stylesheet = stylesheet;
             _sharedStringTable = sharedStringTable;
             _requireCellReferences = requireCellReferences;

diff --git a/src/LargeXlsx/XlsxWriter.cs b/src/LargeXlsx/XlsxWriter.cs
@@ -147,7 +147,7 @@ private void SaveWorkbook()
                 var sheetIndex = 0;
                 foreach (var worksheet in _worksheets)
                 {
-                    worksheetTags.Append($"<sheet name=\"{Util.EscapeXmlAttribute(worksheet.Name)}\" sheetId=\"{worksheet.Id}\" r:id=\"RidWS{worksheet.Id}\"/>");
+                    worksheetTags.Append($"<sheet name=\"{Util.EscapeXmlAttribute(worksheet.Name)}\" sheetId=\"{worksheet.Id}\" {SetState(worksheet)} r:id=\"RidWS{worksheet.Id}\"/>");
                     if (worksheet.AutoFilterAbsoluteRef != null)
                         definedNames.Append($"<definedName name=\"_xlnm._FilterDatabase\" localSheetId=\"{sheetIndex}\" hidden=\"1\">{Util.EscapeXmlText(worksheet.AutoFilterAbsoluteRef)}</definedName>");
                     sheetIndex++;
@@ -163,6 +163,20 @@ private void SaveWorkbook()
             }
         }
 
+        private static string SetState(Worksheet worksheet)
+        {
+            switch (worksheet.VisibleType)
+            {
+                case Visibility.Hidden:
+                    return "state=\"hidden\"";
+                case Visibility.VeryHidden:
+                    return "state=\"veryHidden\"";
+                case Visibility.Visible:
+                default:
+                    return "";
+            }
+        }
+
         private void SaveWorkbookRels()
         {
             using (var stream = _zipWriter.WriteToStream("xl/_rels/workbook.xml.rels", new ZipWriterEntryOptions()))
@@ -180,7 +194,7 @@ private void SaveWorkbookRels()
             }
         }
 
-        public XlsxWriter BeginWorksheet(string name, int splitRow = 0, int splitColumn = 0, bool rightToLeft = false, IEnumerable<XlsxColumn> columns = null, bool showGridLines = true, bool showHeaders = true)
+        public XlsxWriter BeginWorksheet(string name, int splitRow = 0, int splitColumn = 0, bool rightToLeft = false, IEnumerable<XlsxColumn> columns = null, bool showGridLines = true, bool showHeaders = true, Visibility visibleType = Visibility.Visible)
         {
             if (name.Length > MaxSheetNameLength)
                 throw new ArgumentException($"The name \"{name}\" exceeds the maximum length of {MaxSheetNameLength} characters supported by Excel");
@@ -194,6 +208,7 @@ public XlsxWriter BeginWorksheet(string name, int splitRow = 0, int splitColumn
                 splitRow: splitRow,
                 splitColumn: splitColumn,
                 rightToLeft: rightToLeft,
+                visibleType: visibleType,
                 stylesheet: _stylesheet,
                 sharedStringTable: _sharedStringTable,
                 columns: columns ?? Enumerable.Empty<XlsxColumn>(),