xlwings-utils 25.0.5__tar.gz → 25.0.5.post0__tar.gz

{xlwings_utils-25.0.5/xlwings_utils.egg-info → xlwings_utils-25.0.5.post0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xlwings_utils
-Version: 25.0.5
+Version: 25.0.5.post0
 Summary: xlwings_utils
 Author-email: Ruud van der Ham <rt.van.der.ham@gmail.com>
 Project-URL: Homepage, https://github.com/salabim/xlwings_utils
@@ -263,10 +263,93 @@ The capture buffer can also be retrieved as a string with `capture.str` and `cap
 
 Clearing the captured stdout buffer can be done at any time with `capture.clear()`.
 
+## Functionality for accessing local files via VBA
+
+Currently, *xlwings Lite* does not provide access to the local file system. Therefore, xlwings_utils offers some functionality to trigger a VBA script as well as functionality to encode a file in the pyodide file system to a VBA sheet and to trigger writing the encoded file(s) to the local file system.
+
+Note that the sheet must have a worksheet named `VBA`, and the VBA code will normally reside there.
+
+There are three Python functions defined:
+
+  * `trigger_VBA()`
+    fires a VBA script, provided a VBA function is defined on the sheet, like:
+    
+    ```
+    Sub Worksheet_Calculate()
+        If Me.Range("A1").Formula = "=NOW()" Then
+            Me.Range("A1").Value = Null
+            REM Code to run 
+        End If
+    End Sub
+    ```
+  * `init_transfer_files()`
+    This should be called prior to any `transfer_file` call. It just removes all encoded files from the VBA sheet (if any)
+
+  * `transfer_file()`
+    Can be used to encode a file on the pyodide file system to the VBA sheet. Multiple files are allowed. The file name will be encoded on the sheet as well.
+
+The VBA code below can be used to decode encoded file(s) and write to the local file system.
+
+```
+Sub WriteFiles()
+    
+    Dim vArr() As Byte
+    Dim S As String
+    Dim Column As Integer
+    Dim Row As Integer
+    Dim ws As Worksheet
+    Dim Count As Integer
+    Dim FileNames As String
+    
+    Column = 1
+    Row = 1
+    
+    ThisDir = ThisWorkbook.Path
+    Set ws = Me
+    Count = 0
+    While Row < 30000
+        Line = ws.Cells(Row, Column)
+        If InStr(Line, "<file=") = 1 And Right(Line, 1) = ">" Then
+            If Count <> 0 Then
+                FileNames = FileNames & ", "
+            End If
+            Count = Count + 1
+            FileNameOnly = Mid(Line, 7, Len(Line) - 7)
+            Filename = ThisDir & "/" & FileNameOnly
+            FileNames = FileNames & FileNameOnly
+            
+            Row = Row + 1
+            S = ""
+            While ws.Cells(Row, Column) <> "</file>"
+                S = S & ws.Cells(Row, Column)
+                Row = Row + 1
+            Wend
+                
+            vArr = Base64ToArray(S)
+        
+            Open Filename For Binary Access Write As #1
+            WritePos = 1
+            Put #1, WritePos, vArr
+            Close #1
+        End If
+        
+        Row = Row + 1
+    
+    Wend
+    If Cells(4, 2) = "y" Then
+        ws.Range("A10:A1000000").Clear
+    End If
+    
+    If Count = 0 Then
+        MsgBox "No files written"
+    Else
+        MsgBox "Successfully written " & Str(Count) & " file(s): " & FileNames
+    End If
+```
 
 ## Contact info
 
-You can contact Ruud van der Ham, the core developer, via ruud@salabim.org .
+You can contact Ruud van der Ham, the core developer, at ruud@salabim.org.
 
 ## Badges