Cmdlet

Show-ConsoleRule

Module: ConsoleMonster
Inputs: None

Writes a horizontal rule, optionally with a title.

Syntax

Show-ConsoleRule
[-Alignment <Left|Center|Right>]
[-AsString]
[-AsWidget]
[[-Title] <Object>]
[-Width <Int32>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

A quick section separator for scripts.

Examples

Example 1

Show-ConsoleRule 'Step 2: collect'

A section header

Parameters

-Alignment HorizontalAlignment optional: Alignment of the section title (default left, as on the rule builder).; Possible values: Left, Center, Right
-AsString SwitchParameter optional: Returns plain text without drawing.
-AsWidget SwitchParameter optional: Returns the rule widget without drawing.
-Title Object optionalposition: 0: The title (markup allowed).
-Width Int32 optional: The width in cells (default the window), to match other output laid out with -Width.

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.