API Reference
Command
New-BGInfoValue
Creates a BGInfo value entry.
Remarks
Creates a BGInfo value entry.
Examples
EXAMPLE 1
New-BGInfoValue -Name 'Name' -Value 'Value'
EXAMPLE 2
New-BGInfoValue -BuiltinValue 'Value'
EXAMPLE 3
New-BGInfoValue -Name 'Name' -Value 'Value' -ForEach '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-BGInfoValue [-Color <Object>] [-FontFamilyName <String>] [-FontSize <Single>] -Name <String> -Value <String> [-ValueColor <Object>] [-ValueFontFamilyName <String>] [-ValueFontSize <Single>] [<CommonParameters>]Parameter set:
ValuesParameters
- Color Object
- Label color override.
- FontFamilyName String
- Label font family override.
- FontSize Single
- Label font size override.
- Name String
- Label text to render.
- Value String
- Explicit value to render.
- ValueColor Object
- Value color override.
- ValueFontFamilyName String
- Value font family override.
- ValueFontSize Single
- Value font size override.
Outputs
PowerBGInfo.BgInfoEntry
New-BGInfoValue -BuiltinValue <UserName> [-Color <Object>] [-FontFamilyName <String>] [-FontSize <Single>] -Name <String> [-ValueColor <Object>] [-ValueFontFamilyName <String>] [-ValueFontSize <Single>] [<CommonParameters>]Parameter set:
BuiltinParameters
- BuiltinValue String
- Built-in token to resolve to a value.
- Possible values:
UserName,HostName,FullUserName,CpuName,CpuMaxClockSpeed,CpuCores,CpuLogicalCores,RAMSize,RAMSpeed,RAMPartNumber,BiosVersion,BiosManufacturer,BiosReleaseDate,OSName,OSVersion,OSArchitecture,OSBuild,OSInstallDate,OSLastBootUpTime,UserDNSDomain,FQDN,IPv4Address,IPv6Address - Color Object
- Label color override.
- FontFamilyName String
- Label font family override.
- FontSize Single
- Label font size override.
- Name String
- Label text to render.
- ValueColor Object
- Value color override.
- ValueFontFamilyName String
- Value font family override.
- ValueFontSize Single
- Value font size override.
Outputs
PowerBGInfo.BgInfoEntry
New-BGInfoValue [-Color <Object>] [-FontFamilyName <String>] [-FontSize <Single>] -ForEach <String> -Name <String> -Value <String> [-ValueColor <Object>] [-ValueFontFamilyName <String>] [-ValueFontSize <Single>] [<CommonParameters>]Parameter set:
TemplateParameters
- Color Object
- Label color override.
- FontFamilyName String
- Label font family override.
- FontSize Single
- Label font size override.
- ForEach String
- Variable name used to expand this entry multiple times.
- Name String
- Label text to render.
- Value String
- Explicit value to render.
- ValueColor Object
- Value color override.
- ValueFontFamilyName String
- Value font family override.
- ValueFontSize Single
- Value font size override.
Outputs
PowerBGInfo.BgInfoEntry