chore: 🔧 Update CHANGELOG for version 0.3.0 and add new examples

PrzemyslawKlys · PrzemyslawKlys · commit 1938d3c59ff6 · 2025-12-29T23:46:30.000+01:00
* Bump version to `0.3.0` with breaking changes.
* Remove legacy dependencies and cmdlet surface.
* Add new examples for PowerPoint and Excel functionalities.
* Enhance README and TODO with updated project vision and goals.
diff --git a/CHANGELOG.MD b/CHANGELOG.MD
@@ -1,6 +1,10 @@
-﻿#### 0.2.0 - 2024.02.21
+#### 0.3.0 - 2025.12.29
+- Rebooted on OfficeIMO.* (Word/Excel/PowerPoint/Markdown/CSV/Word.Html) with breaking changes.
+- Removed legacy external dependencies and old cmdlet surface.
+- Added rebooted DSL examples and tests.
+
+#### 0.2.0 - 2024.02.21
 - Updated `OfficeIMO.Word` to `0.13.0`
-- Updated `ClosedXML` to `0.102.2`
 
 #### 0.1.0 - 2023.06.23
 - Updated `OfficeIMO.Word` to **0.5.0** which has many improvements and new features
@@ -14,9 +18,7 @@
 - Fixes `Close-OfficeWord` to properly dipose of document
 
 #### 0.0.4 - 2022.08.14
-- Added `Import-OfficeExcel` to import Excel files as PowerShell objects
 - Library `OfficeIMO.Word` updated to **0.2.1** which has many improvements around Tables and basic Charts support
-- Library `ClosedXML` updated to **0.96.0**
 
 #### 0.0.3 - 2022.06.05
 - Library `OfficeIMO.Word` updated to **0.1.5** which fixes
diff --git a/Examples/Csv/Example-CsvAdvanced.ps1 b/Examples/Csv/Example-CsvAdvanced.ps1
@@ -0,0 +1,16 @@
+Import-Module (Join-Path $PSScriptRoot '..\..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot '..\Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'Csv-Advanced.csv'
+$rows = @(
+    [PSCustomObject]@{ Name = 'Alpha'; Score = 92; Active = $true }
+    [PSCustomObject]@{ Name = 'Beta'; Score = 76; Active = $true }
+    [PSCustomObject]@{ Name = 'Gamma'; Score = 64; Active = $false }
+)
+
+$rows | ConvertTo-OfficeCsv -OutputPath $path -Delimiter ';' | Out-Null
+
+Write-Host "CSV saved to $path"
+Get-OfficeCsvData -Path $path -Delimiter ';' -AsHashtable | Format-Table
diff --git a/Examples/ExamplePowerPoint01-AddSlides.ps1 b/Examples/ExamplePowerPoint01-AddSlides.ps1
@@ -1,22 +1,19 @@
-Clear-Host
-#Import-Module .\PSWriteOffice.psd1 -Force
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
 
-$Presentation = New-OfficePowerPoint -FilePath "$PSScriptRoot\Documents\ExamplePowerPoint1.pptx"
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
 
-Add-OfficePowerPointSlide -Presentation $Presentation -Layout 1
+$path = Join-Path $documents 'ExamplePowerPoint1.pptx'
+$presentation = New-OfficePowerPoint -FilePath $path
 
-Write-Host $Presentation.Slides.Count -ForegroundColor Green
+$slide1 = Add-OfficePowerPointSlide -Presentation $presentation -Layout 1
+Set-OfficePowerPointSlideTitle -Slide $slide1 -Title 'Status Update' | Out-Null
+Add-OfficePowerPointTextBox -Slide $slide1 -Text 'Generated with PSWriteOffice' -X 80 -Y 150 -Width 320 -Height 40 | Out-Null
+Add-OfficePowerPointShape -Slide $slide1 -ShapeType Rectangle -X 80 -Y 210 -Width 320 -Height 120 -FillColor '#DDEEFF' -OutlineColor '#4472C4' -OutlineWidth 1 | Out-Null
 
-# Get the shapes collection from the first slide
-$shapes = $Presentation.Slides[0].Shapes
+$slide2 = Add-OfficePowerPointSlide -Presentation $presentation -Layout 1
+Set-OfficePowerPointSlideTitle -Slide $slide2 -Title 'Next Steps' | Out-Null
+Add-OfficePowerPointTextBox -Slide $slide2 -Text '1. Review numbers  2. Plan Q1  3. Ship' -X 80 -Y 150 -Width 360 -Height 80 | Out-Null
 
-# Add a new rectangle shape
-$shapes.AddRectangle(50, 60, 100, 70)
-
-$shapes.Item(0).TextBox.Text = "Hello World!"
-
-$Presentation.Slides[1].Shapes | Format-Table
-
-$Presentation.Slides[1].Shapes[0].TextBox.Text = "This is my title"
-
-Save-OfficePowerPoint -Presentation $Presentation -Show
+Save-OfficePowerPoint -Presentation $presentation
+Write-Host "Presentation saved to $path"
diff --git a/Examples/ExamplePowerPoint02-Basic.ps1 b/Examples/ExamplePowerPoint02-Basic.ps1
@@ -1,4 +1,12 @@
-Clear-Host
-# Simple example creating and saving a presentation
-$presentation = New-OfficePowerPoint -FilePath "$PSScriptRoot\Documents\BasicExample.pptx"
-Save-OfficePowerPoint -Presentation $presentation -Show
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'BasicExample.pptx'
+$presentation = New-OfficePowerPoint -FilePath $path
+
+Add-OfficePowerPointSlide -Presentation $presentation -Layout 1 | Out-Null
+Save-OfficePowerPoint -Presentation $presentation
+
+Write-Host "Presentation saved to $path"
diff --git a/Examples/ExamplePowerPoint04-Text.ps1 b/Examples/ExamplePowerPoint04-Text.ps1
@@ -1,10 +1,14 @@
-Clear-Host
-# Import-Module .\PSWriteOffice.psd1 -Force
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
 
-$presentation = New-OfficePowerPoint -FilePath "$PSScriptRoot\Documents\ExamplePowerPoint4.pptx"
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'ExamplePowerPoint4.pptx'
+$presentation = New-OfficePowerPoint -FilePath $path
 
 $slide = Add-OfficePowerPointSlide -Presentation $presentation -Layout 1
-Set-OfficePowerPointSlideTitle -Slide $slide -Title 'Quarterly Report'
-Add-OfficePowerPointTextBox -Slide $slide -Text 'Generated with PSWriteOffice'
+Set-OfficePowerPointSlideTitle -Slide $slide -Title 'Quarterly Report' | Out-Null
+Add-OfficePowerPointTextBox -Slide $slide -Text 'Generated with PSWriteOffice' -X 90 -Y 160 -Width 320 -Height 50 | Out-Null
 
-Save-OfficePowerPoint -Presentation $presentation -Show
+Save-OfficePowerPoint -Presentation $presentation
+Write-Host "Presentation saved to $path"
diff --git a/Examples/ExamplePowerPoint05-Load.ps1 b/Examples/ExamplePowerPoint05-Load.ps1
@@ -1,7 +1,12 @@
-Clear-Host
-# Create and load a PowerPoint presentation
-$path = "$PSScriptRoot\Documents\LoadExample.pptx"
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'LoadExample.pptx'
 $presentation = New-OfficePowerPoint -FilePath $path
+Add-OfficePowerPointSlide -Presentation $presentation -Layout 1 | Out-Null
 Save-OfficePowerPoint -Presentation $presentation
+
 $loaded = Get-OfficePowerPoint -FilePath $path
-$loaded
+Write-Host "Loaded presentation with $($loaded.Slides.Count) slide(s)."
diff --git a/Examples/ExamplePowerPoint06-RemoveSlide.ps1 b/Examples/ExamplePowerPoint06-RemoveSlide.ps1
@@ -1,8 +1,14 @@
-Clear-Host
-# Import-Module .\\PSWriteOffice.psd1 -Force
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
 
-$presentation = New-OfficePowerPoint -FilePath "$PSScriptRoot\Documents\ExamplePowerPoint6.pptx"
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'ExamplePowerPoint6.pptx'
+$presentation = New-OfficePowerPoint -FilePath $path
 Add-OfficePowerPointSlide -Presentation $presentation -Layout 1 | Out-Null
 Add-OfficePowerPointSlide -Presentation $presentation -Layout 1 | Out-Null
+
 Remove-OfficePowerPointSlide -Presentation $presentation -Index 0
-Save-OfficePowerPoint -Presentation $presentation -Show
+Save-OfficePowerPoint -Presentation $presentation
+
+Write-Host "Presentation saved to $path"
diff --git a/Examples/ExamplePowerPoint07-WhatIf.ps1 b/Examples/ExamplePowerPoint07-WhatIf.ps1
@@ -1,6 +1,11 @@
-Clear-Host
-# Demonstrates using WhatIf when saving a presentation
-$path = "$PSScriptRoot\Documents\WhatIfExample.pptx"
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'WhatIfExample.pptx'
 $presentation = New-OfficePowerPoint -FilePath $path
 Add-OfficePowerPointSlide -Presentation $presentation -Layout 1 | Out-Null
+
 Save-OfficePowerPoint -Presentation $presentation -WhatIf
+Write-Host "WhatIf completed for $path"
diff --git a/Examples/ExamplePowerPoint08-TablesAndShapes.ps1 b/Examples/ExamplePowerPoint08-TablesAndShapes.ps1
@@ -0,0 +1,23 @@
+Import-Module (Join-Path $PSScriptRoot '..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot 'Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$path = Join-Path $documents 'ExamplePowerPoint8-TablesAndShapes.pptx'
+$presentation = New-OfficePowerPoint -FilePath $path
+
+$slide = Add-OfficePowerPointSlide -Presentation $presentation -Layout 1
+Set-OfficePowerPointSlideTitle -Slide $slide -Title 'Tables & Shapes' | Out-Null
+
+$data = @(
+    [PSCustomObject]@{ Product = 'Alpha'; Qty = 12; Revenue = 1200 }
+    [PSCustomObject]@{ Product = 'Beta'; Qty = 7; Revenue = 940 }
+    [PSCustomObject]@{ Product = 'Gamma'; Qty = 20; Revenue = 1840 }
+)
+
+Add-OfficePowerPointTable -Slide $slide -Data $data -X 60 -Y 140 -Width 420 -Height 200 | Out-Null
+Add-OfficePowerPointShape -Slide $slide -ShapeType Ellipse -X 520 -Y 140 -Width 140 -Height 140 -FillColor '#FFE699' -OutlineColor '#C65911' -OutlineWidth 1 | Out-Null
+Add-OfficePowerPointTextBox -Slide $slide -Text 'Highlights' -X 530 -Y 300 -Width 120 -Height 40 | Out-Null
+
+Save-OfficePowerPoint -Presentation $presentation
+Write-Host "Presentation saved to $path"
diff --git a/Examples/Excel/Example-ExcelTablesAndRanges.ps1 b/Examples/Excel/Example-ExcelTablesAndRanges.ps1
@@ -0,0 +1,26 @@
+Import-Module (Join-Path $PSScriptRoot '..\..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot '..\Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$data = @(
+    [PSCustomObject]@{ Region = 'North America'; Revenue = 125000; Owner = 'Ada' }
+    [PSCustomObject]@{ Region = 'EMEA'; Revenue = 98000; Owner = 'Linus' }
+    [PSCustomObject]@{ Region = 'APAC'; Revenue = 143000; Owner = 'Grace' }
+)
+
+$path = Join-Path $documents 'Excel-TablesAndRanges.xlsx'
+New-OfficeExcel -Path $path {
+    ExcelSheet 'Summary' {
+        Set-OfficeExcelRow -Row 1 -Values 'Region', 'Revenue', 'Owner'
+        Add-OfficeExcelTable -Data $data -TableName 'Sales' -TableStyle 'TableStyleMedium9' -AutoFit
+        Set-OfficeExcelNamedRange -Name 'Revenue' -Range 'B2:B4'
+    }
+    ExcelSheet 'Notes' {
+        ExcelCell -Address 'A1' -Value 'Generated by PSWriteOffice'
+    }
+} | Out-Null
+
+Write-Host "Workbook saved to $path"
+Write-Host 'Tables:'
+Get-OfficeExcelTable -Path $path | Format-Table
diff --git a/Examples/Word/Example-WordTableConditions.ps1 b/Examples/Word/Example-WordTableConditions.ps1
@@ -0,0 +1,24 @@
+Import-Module (Join-Path $PSScriptRoot '..\..\PSWriteOffice.psd1') -Force
+
+$documents = Join-Path $PSScriptRoot '..\Documents'
+New-Item -Path $documents -ItemType Directory -Force | Out-Null
+
+$data = @(
+    [PSCustomObject]@{ Name = 'Alpha'; Score = 92; Owner = 'Ada' }
+    [PSCustomObject]@{ Name = 'Beta'; Score = 76; Owner = 'Linus' }
+    [PSCustomObject]@{ Name = 'Gamma'; Score = 64; Owner = 'Grace' }
+)
+
+$docPath = Join-Path $documents 'Word-TableConditions.docx'
+New-OfficeWord -Path $docPath {
+    WordSection {
+        WordParagraph 'Quality Matrix' -Style Heading1
+        WordParagraph 'Rows are highlighted based on score thresholds.'
+        WordTable -Data $data -Style TableGrid -Layout Autofit {
+            WordTableCondition -FilterScript { $_.Score -ge 90 } -BackgroundColor '#e6fffb'
+            WordTableCondition -FilterScript { $_.Score -lt 70 } -BackgroundColor '#ffe6e6'
+        }
+    }
+} | Out-Null
+
+Write-Host "Document saved to $docPath"
diff --git a/PSWriteOffice.psd1 b/PSWriteOffice.psd1
@@ -1,22 +1,21 @@
 ﻿@{
     AliasesToExport        = @('WordSection', 'WordHeader', 'WordFooter', 'WordParagraph', 'WordText', 'WordBold', 'WordItalic', 'WordList', 'WordListItem', 'WordTable', 'WordTableCondition', 'WordImage', 'WordField', 'WordPageNumber', 'WordWatermark', 'Convert-WordToHtml', 'Convert-HtmlToWord', 'Convert-MarkdownToHtml', 'ExcelSheet', 'ExcelCell', 'ExcelRow', 'ExcelColumn', 'ExcelTable', 'ExcelNamedRange', 'ExcelFormula', 'ExcelHeaderFooter', 'ExcelAutoFit', 'ExcelValidationList')
     Author                 = 'Przemyslaw Klys'
-    CmdletsToExport        = @('Add-OfficeWordFooter', 'Add-OfficeWordHeader', 'Add-OfficeWordImage', 'Add-OfficeWordList', 'Add-OfficeWordListItem', 'Add-OfficeWordPageNumber', 'Add-OfficeWordParagraph', 'Add-OfficeWordSection', 'Add-OfficeWordTable', 'Add-OfficeWordTableCondition', 'Add-OfficeWordText', 'Add-OfficeWordField', 'Add-OfficeWordWatermark', 'Protect-OfficeWordDocument', 'Close-OfficeWord', 'Save-OfficeWord', 'Get-OfficeWord', 'Get-OfficeWordSection', 'Get-OfficeWordParagraph', 'Get-OfficeWordTable', 'Get-OfficeWordRun', 'New-OfficeWord', 'Find-OfficeWord', 'Get-OfficeWordBookmark', 'Get-OfficeWordField', 'ConvertTo-OfficeWordHtml', 'ConvertFrom-OfficeWordHtml', 'Add-OfficePowerPointSlide', 'Add-OfficePowerPointTextBox', 'Get-OfficePowerPoint', 'Get-OfficePowerPointSlide', 'New-OfficePowerPoint', 'Remove-OfficePowerPointSlide', 'Save-OfficePowerPoint', 'Set-OfficePowerPointSlideTitle', 'Add-OfficeExcelSheet', 'Add-OfficeExcelTable', 'Add-OfficeExcelValidationList', 'Close-OfficeExcel', 'Save-OfficeExcel', 'Get-OfficeExcel', 'Get-OfficeExcelData', 'Get-OfficeExcelNamedRange', 'Get-OfficeExcelTable', 'Invoke-OfficeExcelAutoFit', 'New-OfficeExcel', 'Set-OfficeExcelCell', 'Set-OfficeExcelRow', 'Set-OfficeExcelColumn', 'Set-OfficeExcelNamedRange', 'Set-OfficeExcelFormula', 'Set-OfficeExcelHeaderFooter', 'Get-OfficeMarkdown', 'ConvertTo-OfficeMarkdown', 'ConvertTo-OfficeMarkdownHtml', 'Get-OfficeCsv', 'Get-OfficeCsvData', 'ConvertTo-OfficeCsv')
+    CmdletsToExport        = @('Add-OfficeWordFooter', 'Add-OfficeWordHeader', 'Add-OfficeWordImage', 'Add-OfficeWordList', 'Add-OfficeWordListItem', 'Add-OfficeWordPageNumber', 'Add-OfficeWordParagraph', 'Add-OfficeWordSection', 'Add-OfficeWordTable', 'Add-OfficeWordTableCondition', 'Add-OfficeWordText', 'Add-OfficeWordField', 'Add-OfficeWordWatermark', 'Protect-OfficeWordDocument', 'Close-OfficeWord', 'Save-OfficeWord', 'Get-OfficeWord', 'Get-OfficeWordSection', 'Get-OfficeWordParagraph', 'Get-OfficeWordTable', 'Get-OfficeWordRun', 'New-OfficeWord', 'Find-OfficeWord', 'Get-OfficeWordBookmark', 'Get-OfficeWordField', 'ConvertTo-OfficeWordHtml', 'ConvertFrom-OfficeWordHtml', 'Add-OfficePowerPointSlide', 'Add-OfficePowerPointTextBox', 'Add-OfficePowerPointShape', 'Add-OfficePowerPointTable', 'Get-OfficePowerPoint', 'Get-OfficePowerPointSlide', 'New-OfficePowerPoint', 'Remove-OfficePowerPointSlide', 'Save-OfficePowerPoint', 'Set-OfficePowerPointSlideTitle', 'Add-OfficeExcelSheet', 'Add-OfficeExcelTable', 'Add-OfficeExcelValidationList', 'Close-OfficeExcel', 'Save-OfficeExcel', 'Get-OfficeExcel', 'Get-OfficeExcelData', 'Get-OfficeExcelNamedRange', 'Get-OfficeExcelTable', 'Invoke-OfficeExcelAutoFit', 'New-OfficeExcel', 'Set-OfficeExcelCell', 'Set-OfficeExcelRow', 'Set-OfficeExcelColumn', 'Set-OfficeExcelNamedRange', 'Set-OfficeExcelFormula', 'Set-OfficeExcelHeaderFooter', 'Get-OfficeMarkdown', 'ConvertTo-OfficeMarkdown', 'ConvertTo-OfficeMarkdownHtml', 'Get-OfficeCsv', 'Get-OfficeCsvData', 'ConvertTo-OfficeCsv')
     CompanyName            = 'Evotec'
     CompatiblePSEditions   = @('Desktop', 'Core')
     Copyright              = '(c) 2011 - 2025 Przemyslaw Klys @ Evotec. All rights reserved.'
-    Description            = 'Experimental PowerShell Module to create and edit Microsoft Word, Microsoft Excel, and Microsoft PowerPoint documents without having Microsoft Office installed.'
+    Description            = 'PowerShell module to create and read Microsoft Word, Excel, PowerPoint (experimental), Markdown, and CSV documents without Microsoft Office installed. Powered by OfficeIMO.*.'
     DotNetFrameworkVersion = '4.7.2'
     FunctionsToExport      = @()
     GUID                   = 'd75a279d-30c2-4c2d-ae0d-12f1f3bf4d39'
     ModuleVersion          = '0.3.0'
     PowerShellVersion      = '5.1'
     PrivateData            = @{
         PSData = @{
-            IconUri    = 'https://evotec.xyz/wp-content/uploads/2018/10/PSWriteWord.png'
             LicenseUri = 'https://github.com/EvotecIT/PSWriteOffice/blob/master/License'
             ProjectUri = 'https://github.com/EvotecIT/PSWriteOffice'
-            Tags       = @('word', 'docx', 'write', 'PSWord', 'office', 'windows', 'doc', 'pswriteword', 'linux', 'macos')
+            Tags       = @('officeimo', 'word', 'excel', 'powerpoint', 'markdown', 'csv', 'docx', 'xlsx', 'pptx', 'openxml', 'windows', 'linux', 'macos')
         }
     }
     RootModule             = 'PSWriteOffice.psm1'
diff --git a/README.MD b/README.MD
@@ -20,13 +20,8 @@
   <a href="https://www.linkedin.com/in/pklys"><img src="https://img.shields.io/badge/LinkedIn-pklys-0077B5.svg?logo=LinkedIn&style=flat-square"></a>
 </p>
 
-`PSWriteOffice` is cross-platform PowerShell module for writing Microsoft Office documents (`Word`, `Excel`, and `PowerPoint` - experimental).
-This module long term goal is to fully replace:
-
-- [PSWriteWord](https://github.com/EvotecIT/PSWriteWord) - this module works only in Windows PowerShell 5.1, and DLL license has changed making updates to it very hard.
-- [PSWriteExcel](https://github.com/EvotecIT/PSWriteExcel) - this module worked cross-platform but DLL maintainer moved to pay project leaving the old DLL unmaintained.
-
-While at this moment this module doesn't expose all DLL features, and some features are strictly available in by using their net methods, the goal is to expose it fully using PowerShell.
+`PSWriteOffice` is a cross-platform PowerShell module for creating and reading Microsoft Office documents (`Word`, `Excel`, `PowerPoint` - experimental), plus `Markdown` and `CSV`, powered by OfficeIMO.*.
+It provides verb-noun cmdlets and a scriptblock-first DSL while OfficeIMO owns the core engine and tests.
 
 This module is built using following libraries:
 - [Open XML SDK for .NET](https://github.com/OfficeDev/Open-XML-SDK) licensed MIT - Microsoft's library doing heavy lifting for all other Open XML projects.
diff --git a/TODO.MD b/TODO.MD
diff --git a/Tests/PowerPoint.Tests.ps1 b/Tests/PowerPoint.Tests.ps1
