Write HostFormatted

---

external help file: XpandPwsh-help.xml Module Name: XpandPwsh

schema: 2.0.0

Write-HostFormatted

SYNOPSIS

Text formatting.

SYNTAX

Write-HostFormatted [[-Object] <Object>] [-ForegroundColor <ConsoleColor>] [-BackgroundColor <ConsoleColor>]
 [-Style <String[]>] [-NoNewline] [-Section] [-AnsiColors] [-Indent <Int32>] [-Stream <String>]
 [<CommonParameters>]

DESCRIPTION

Text formatting.

EXAMPLES

Example 1

PS C:\> Write-HostFormatted Text formatting. -Section
-----------
formatting.
-----------

Frame the formating text.

PARAMETERS

-AnsiColors

{{ Fill AnsiColors Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-BackgroundColor

{{ Fill BackgroundColor Description }}

Type: ConsoleColor
Parameter Sets: (All)
Aliases: bg
Accepted values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ForegroundColor

{{ Fill ForegroundColor Description }}

Type: ConsoleColor
Parameter Sets: (All)
Aliases: fg
Accepted values: Black, DarkBlue, DarkGreen, DarkCyan, DarkRed, DarkMagenta, DarkYellow, Gray, DarkGray, Blue, Green, Cyan, Red, Magenta, Yellow, White

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Indent

{{ Fill Indent Description }}

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoNewline

{{ Fill NoNewline Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases: nnl

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Object

{{ Fill Object Description }}

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Section

{{ Fill Section Description }}

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Stream

{{ Fill Stream Description }}

Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Output, Verbose

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Style

{{ Fill Style Description }}

Type: String[]
Parameter Sets: (All)
Aliases:
Accepted values: Bold, Inverted, Underline, Frame

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.Object

OUTPUTS

System.Object

NOTES

RELATED LINKS