Project

PowerBGInfo

Generate support-ready Windows desktop and logon backgrounds from PowerShell data, charts, and topology.

View on GitHub Releases Get package
Stars 312
Forks 27
PowerShell Gallery downloads 612,914
Release v2.0.3
Language: C# Updated: 2026-09-02

API Reference

Command

New-BGInfo

Namespace PowerBGInfo
Inputs
None
Outputs
System.String PowerBGInfo.BgInfoConfiguration

Creates a BGInfo overlay image and optionally applies it as wallpaper.

Remarks

Use the script block to emit label/value entries.

Guides & Samples

Authored walkthroughs and practical samples linked to this API.

  • Deploy PowerBGInfo safely Workflow

    Choose the output target, test at the real monitor resolution, and deploy reviewed JSON through logon, scheduled, or RMM automation.

  • Curated PowerBGInfo examples Example

    Build reusable configurations, operational charts, topology overlays, and visual canvases.

Examples

Authored help example

EXAMPLE 1


New-BGInfo -ConfigurationDirectory 'Value'

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-BGInfo [-AllUsers] [-BackgroundColor <Object>] -BGInfoContent <ScriptBlock> [-ChartLayout <Manual|Stack>] [-ChartStackAlignToTextBlock] [-ChartStackAnchor <TopLeft>] [-ChartStackDirection <Vertical|Horizontal>] [-ChartStackOffsetX <Int32>] [-ChartStackOffsetY <Int32>] [-ChartStackOutsideTextBlock] [-ChartStackSpacing <Int32>] [-Color <Object>] -ConfigurationDirectory <String> [-DisableWallpaperRefresh] [-DisableWallpaperSlideshow] [-ExcludeDefaultUserProfile] [-ExportOnly] [-FilePath <String>] [-FontFamilyName <String>] [-FontSize <Int32>] [-JsonPath <String>] [-MonitorIndex <Int32>] [-OutputFileName <String>] [-PassThru] [-PositionX <Single>] [-PositionY <Single>] [-SpaceBetweenColumns <Int32>] [-SpaceBetweenLines <Int32>] [-SpaceX <Int32>] [-SpaceY <Int32>] [-Target <Wallpaper|LogonScreen|Both|File>] [-TextPosition <TopLeft>] [-UseScreenCoordinates] [-ValueColor <Object>] [-ValueFontFamilyName <String>] [-ValueFontSize <Single>] [-ValueWrapWidth <Int32>] [-WallpaperFit <Center>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

AllUsers SwitchParameter optionalposition: namedpipeline: False
Apply wallpaper for all user profiles.
BackgroundColor Object optionalposition: namedpipeline: False
Background color to use when no wallpaper image is available.
BGInfoContent ScriptBlock requiredposition: 0pipeline: False
Script block that outputs BGInfo entries.
ChartLayout BgInfoChartLayoutMode optionalposition: namedpipeline: Falsevalues: 2
Chart layout mode.
Possible values: Manual, Stack
ChartStackAlignToTextBlock SwitchParameter optionalposition: namedpipeline: False
Align stacked charts to the text block.
ChartStackAnchor BgInfoTextPosition optionalposition: namedpipeline: Falsevalues: 9
Anchor used when stacking charts.
Possible values: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight
ChartStackDirection BgInfoChartStackDirection optionalposition: namedpipeline: Falsevalues: 2
Direction used when stacking charts.
Possible values: Vertical, Horizontal
ChartStackOffsetX Int32 optionalposition: namedpipeline: False
Horizontal offset for stacked charts.
ChartStackOffsetY Int32 optionalposition: namedpipeline: False
Vertical offset for stacked charts.
ChartStackOutsideTextBlock SwitchParameter optionalposition: namedpipeline: False
Place stacked charts outside the text block.
ChartStackSpacing Int32 optionalposition: namedpipeline: False
Spacing between stacked charts.
Color Object optionalposition: namedpipeline: False
Default label color.
ConfigurationDirectory String requiredposition: namedpipeline: False
Output directory for generated BGInfo images.
DisableWallpaperRefresh SwitchParameter optionalposition: namedpipeline: False
Disable the forced wallpaper refresh after generation.
DisableWallpaperSlideshow SwitchParameter optionalposition: namedpipeline: False
Disable automatic preservation of the current Windows wallpaper slideshow.
ExcludeDefaultUserProfile SwitchParameter optionalposition: namedpipeline: False
Exclude the default user profile when applying to all users.
ExportOnly SwitchParameter optionalposition: namedpipeline: False
Export JSON only and skip image generation/application. Requires JsonPath.
FilePath String optionalposition: namedpipeline: False
Optional base wallpaper file path. When omitted, current wallpaper is used.
FontFamilyName String optionalposition: namedpipeline: False
Default label font family.
FontSize Int32 optionalposition: namedpipeline: False
Default label font size.
JsonPath String optionalposition: namedpipeline: False
Optional path where the generated configuration JSON should be saved.
MonitorIndex Int32 optionalposition: namedpipeline: False
Monitor index to target for wallpaper operations.
OutputFileName String optionalposition: namedpipeline: False
Optional output file name for the generated image.
PassThru SwitchParameter optionalposition: namedpipeline: False
Return the generated configuration object instead of rendering the image.
PositionX Single optionalposition: namedpipeline: False
Legacy position X placeholder (reserved for future layout strategies).
PositionY Single optionalposition: namedpipeline: False
Legacy position Y placeholder (reserved for future layout strategies).
SpaceBetweenColumns Int32 optionalposition: namedpipeline: False
Spacing between label and value columns.
SpaceBetweenLines Int32 optionalposition: namedpipeline: False
Vertical spacing between rows.
SpaceX Int32 optionalposition: namedpipeline: False
X padding used for layout positioning.
SpaceY Int32 optionalposition: namedpipeline: False
Y padding used for layout positioning.
Target BgInfoTarget optionalposition: namedpipeline: Falsevalues: 4
Output target (Wallpaper, File, LogonScreen, or Both).
Possible values: Wallpaper, LogonScreen, Both, File
TextPosition BgInfoTextPosition optionalposition: namedpipeline: Falsevalues: 9
Layout anchor position (for example TopLeft, TopCenter, BottomRight).
Possible values: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight
UseScreenCoordinates SwitchParameter optionalposition: namedpipeline: False
Use screen coordinates for placement calculations.
ValueColor Object optionalposition: namedpipeline: False
Default value color.
ValueFontFamilyName String optionalposition: namedpipeline: False
Default value font family.
ValueFontSize Single optionalposition: namedpipeline: False
Default value font size.
ValueWrapWidth Int32 optionalposition: namedpipeline: False
Maximum width used when wrapping value text. Set to 0 to disable wrapping.
WallpaperFit DesktopWallpaperPosition optionalposition: namedpipeline: Falsevalues: 6
Wallpaper fit mode used after generation.
Possible values: Center, Tile, Stretch, Fit, Fill, Span

Outputs

System.String, PowerBGInfo.BgInfoConfiguration