< Back

Write-Banner

Sun Jan 19, 2020 6:09 pm

NAME Write-Banner



SYNOPSIS

Write banner string to the console.





SYNTAX

Write-Banner [-InputObject] <PSObject> [-FontName <String>] [-FontSize <Int32>] [-Bold] [-Italic] [-Strikeout]

[-Underline] [-Stream] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-InputObject <PSObject>

Specify the object to write banner string.

if the object's type is not string, "Name" property value or "ToString()" method result is choosen.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-FontName <String>

Specify the font family name.

Get-FontFamilies cmdlet can get all available font family names.



Required? false

Position? named

Default value Consolas

Accept pipeline input? false

Accept wildcard characters? false



-FontSize <Int32>

Font size(pt).



Required? false

Position? named

Default value 10

Accept pipeline input? false

Accept wildcard characters? false



-Bold [<SwitchParameter>]

Specify using Bold for font style.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Italic [<SwitchParameter>]

Specify using Italic for font style.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Strikeout [<SwitchParameter>]

Specify using Strikeout for font style.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Underline [<SwitchParameter>]

Specify using Underline for font style.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Stream [<SwitchParameter>]

Default false.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS