Skip to main content

PowerShell reference

This section describes the 16 functions exported by Fluence.Wpf.PowerShell and the values they exchange. Each command page is generated from its function's comment-based help by Generate-PowerShellReference.ps1. Update source help and regenerate a page when command behavior changes.

Dialogs and input​

CommandPurpose
Show-FluenceMessageShow a message or preset confirmation; return a button name.
Show-FluenceDialogShow a dialog from prompt and button specifications.
Get-FluenceInputAsk for one value.
Show-FluenceListSelectionSelect one or several list items.
Show-FluenceRestartPromptAsk to restart now or later with an optional countdown.
New-FluencePromptDefine a field, its default, and validation.
New-FluenceButtonDefine an action and its result name.

Progress and windows​

CommandPurpose
Show-FluenceProgressOpen a progress window and return its handle.
Update-FluenceProgressUpdate a progress window through its handle.
Close-FluenceProgressClose a progress window.
Show-FluenceWindowHost a XAML or PowerShell built window.
Close-FluenceWindowClose a hosted window and optionally return a value.

Appearance​

CommandPurpose
Set-FluenceThemeRequest a light, dark, high contrast, or system theme.
Set-FluenceAccentSelect a custom or system accent.
Set-FluenceBackdropSet a process backdrop or change an open window.
Get-FluenceThemeRead requested and resolved appearance state.

Values and module files​

  • Input types lists all 14 New-FluencePrompt -InputType values, controls, default values, and validation behavior.
  • Result objects defines dialog outcome flags, prompt and button specifications, progress handles, window results, and theme information.
  • The module manifest declares exports and supported PowerShell editions. The module setup guide describes the two staged library builds.

Shared values​

OptionAccepted valuesInitial state
ThemeAuto, Light, Dark, HighContrastAuto on first Fluence call.
BackdropMica, Acrylic, Tabbed, None, AutoMica on first Fluence call.
Dialog iconNone, Info, Success, Warning, Error, QuestionDepends on command.
PositionCenter, TopRight, BottomRightCenter.
Message alignmentLeft, CenterLeft.
Timeout1 through 86400 secondsNo timeout unless supplied.

The test runner sets FLUENCE_PS_UI=1 when -IncludeUi is used. This variable controls UI tagged Pester tests; it is not a module appearance option.