ConvertTo FramedText

---

external help file: XpandPwsh-help.xml Module Name: XpandPwsh online version: schema: 2.0.0

ConvertTo-FramedText

SYNOPSIS

Formats text with a customizable frame.

SYNTAX

ConvertTo-FramedText [-stringIN] <String> [-char <String>] [-NoRoof] [-Stream <String>]
 [-ForegroundColor <ConsoleColor>] [-BackgroundColor <ConsoleColor>] [<CommonParameters>]

DESCRIPTION

Formats text with a customizable frame.

EXAMPLES

Example 1

PS C:\> ConvertTo-FramedText test
----
test
----

Frame the test text with dashes.

PARAMETERS

-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

-NoRoof

{{ Fill NoRoof 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

-char

{{ Fill char Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-stringIN

{{ Fill stringIN Description }}

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
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.String

OUTPUTS

System.Object

NOTES

RELATED LINKS