Private/Write-UILog.ps1
|
#Requires -Version 5.1 <# .SYNOPSIS Appends a timestamped entry to the UI log panel in a thread-safe manner. .DESCRIPTION Uses Dispatcher.Invoke to marshal the UI update back to the WPF UI thread, making it safe to call from any runspace. If the message is null or whitespace it is silently ignored. .PARAMETER Message The text to append. A [HH:mm:ss] timestamp is prepended automatically. .PARAMETER Level Log level. Affects the CSS-style class applied to the log entry for colour-coding. Defaults to 'Info'. .PARAMETER SyncHash The shared synchronised hashtable. Must contain: - Window : the WPF Window object - LogTextBox : the TextBox control used for log output - LogScrollViewer : the ScrollViewer wrapping the TextBox .EXAMPLE Write-UILog -Message 'Download complete.' -Level Info -SyncHash $syncHash Write-UILog -Message "ERROR: $($_.Exception.Message)" -Level Error -SyncHash $syncHash #> function Write-UILog { [CmdletBinding()] param( [Parameter(Mandatory)] [AllowEmptyString()] [string]$Message, [Parameter()] [ValidateSet('Info', 'Warning', 'Error', 'Cmd')] [string]$Level = 'Info', [Parameter(Mandatory)] [System.Collections.Hashtable]$SyncHash ) if ([string]::IsNullOrWhiteSpace($Message)) { return } $timestamp = Get-Date -Format 'HH:mm:ss' $prefix = switch ($Level) { 'Warning' { 'WARN' } 'Error' { 'ERROR' } 'Cmd' { 'CMD' } default { 'INFO' } } $logEntry = "[$timestamp] [$prefix] $Message" $SyncHash.Window.Dispatcher.Invoke([action] { $SyncHash.LogTextBox.AppendText("$logEntry`r`n") $SyncHash.LogScrollViewer.ScrollToEnd() }, 'Normal') } |