Project

PowerBGInfo

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

Stars 312
Forks 27
PowerShell Gallery downloads 612,914
Release v2.0.3
Language: C# Updated: 2026-09-02

API Reference

Command

New-BGInfoLabel

Namespace PowerBGInfo
Inputs
None
Outputs
PowerBGInfo.BgInfoEntry

Creates a BGInfo label entry.

Remarks

Creates a BGInfo label entry.

Examples

Authored help example

EXAMPLE 1


New-BGInfoLabel -Name 'Name'
        

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-BGInfoLabel [-Color <Object>] [-FontFamilyName <String>] [-FontSize <Single>] [-ForEach <String>] -Name <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

Color Object optionalposition: namedpipeline: False
Label color override.
FontFamilyName String optionalposition: namedpipeline: False
Label font family override.
FontSize Single optionalposition: namedpipeline: False
Label font size override.
ForEach String optionalposition: namedpipeline: False
Variable name used to expand this label multiple times.
Name String requiredposition: namedpipeline: False
Label text to render.

Outputs

PowerBGInfo.BgInfoEntry