Add method to get the FsWorksheet of an FsTable

fslaborg · Mar 16, 2023 · 0062c62 · 0062c62
1 parent 0857107
commit 0062c62
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/src/FsSpreadsheet.ExcelIO/FsExtensions.fs b/src/FsSpreadsheet.ExcelIO/FsExtensions.fs
@@ -68,6 +68,19 @@ module FsExtensions =
             let ra = FsRangeAddress(FsAddress(topLeftBoundary), FsAddress(bottomRightBoundary))
             FsTable(table.Name, ra, table.TotalsRowShown, true)
 
+        /// <summary>Returns the FsWorksheet associated with the FsTable in a given FsWorkbook.</summary>
+        member self.GetWorksheetOfTable(workbook : FsWorkbook) =
+            workbook.GetWorksheets() 
+            |> List.find (
+                fun s -> 
+                    s.Tables 
+                    |> List.exists (fun t -> t.Name = self.Name)
+            )
+
+        /// <summary>Returns the FsWorksheet associated with a given FsTable in an FsWorkbook.</summary>
+        static member getWorksheetOfTable workbook (table : FsTable) =
+            table.GetWorksheetOfTable workbook
+
 
     type FsWorksheet with
 

diff --git a/src/FsSpreadsheet/Tables/FsTable.fs b/src/FsSpreadsheet/Tables/FsTable.fs
@@ -158,6 +158,4 @@ type FsTable (name : string, rangeAddress, showTotalsRow, showHeaderRow) =
             _fieldNames.Remove(oldName) |> ignore
             _fieldNames.Add(newName, field)
         | None -> 
-            raise (System.ArgumentException("The field does not exist in this table", "oldName"))
-
-
+            raise (System.ArgumentException("The field does not exist in this table", "oldName"))
diff --git a/tests/FsSpreadsheet.ExcelIO.Tests/FsExtensions.fs b/tests/FsSpreadsheet.ExcelIO.Tests/FsExtensions.fs
@@ -41,6 +41,10 @@ let dummyFsWorksheet1 = FsWorksheet("StringSheet",      [], [],             dumm
 let dummyFsWorksheet2 = FsWorksheet("NumericSheet",     [], [],             dummyFsCellsCollection2)
 let dummyFsWorksheet3 = FsWorksheet("TableSheet",       [], [dummyFsTable], dummyFsCellsCollection3)
 let dummyFsWorksheet4 = FsWorksheet("DataTypeSheet",    [], [],             dummyFsCellsCollection4)
+dummyFsWorkbook.AddWorksheet(dummyFsWorksheet1) |> ignore
+dummyFsWorkbook.AddWorksheet(dummyFsWorksheet2) |> ignore
+dummyFsWorkbook.AddWorksheet(dummyFsWorksheet3) |> ignore
+dummyFsWorkbook.AddWorksheet(dummyFsWorksheet4) |> ignore
 
 
 
@@ -85,6 +89,13 @@ let fsExtensionTests =
                     Expect.equal testCell.DataType dtOfCvs "addresses/references are not equal"
             ]
         ]
+        testList "FsTable" [
+            testList "GetWorksheetOfTable" [
+                testCase "gets correct worksheet" <| fun _ ->
+                    let gottenWorksheet = dummyFsTable.GetWorksheetOfTable dummyFsWorkbook
+                    Expect.equal gottenWorksheet.Name dummyFsWorksheet3.Name "Worksheets differ"
+            ]
+        ]
         testList "FsWorkbook" [
             testList "fromXlsxStream" [
                 let fsWorkbookFromStream = FsWorkbook.fromXlsxStream sr.BaseStream