Write-SpectreRule
Description
The Write-SpectreRule function writes a Spectre horizontal-rule to the console with the specified title, alignment, and color.
Examples
Example 1
This example demonstrates how to write a rule to the console.
Write-SpectreRule -Title "My Rule" -Alignment Center -Color Yellow
Parameters
Title
The title of the rule.
Type | Required | Position | PipelineInput |
---|---|---|---|
[String] | false | 1 | false |
Alignment
The alignment of the text in the rule. The default value is Left.
Valid Values:
- Left
- Right
- Center
Type | Required | Position | PipelineInput |
---|---|---|---|
[String] | false | 2 | false |
Color
The color of the rule. The default value is the accent color of the script.
Type | Required | Position | PipelineInput |
---|---|---|---|
[Color] | false | 3 | false |
LineColor
Type | Required | Position | PipelineInput |
---|---|---|---|
[Color] | false | 4 | false |
PassThru
Returns the Spectre Rule object instead of writing it to the console.
Type | Required | Position | PipelineInput |
---|---|---|---|
[Switch] | false | named | false |
Syntax
Write-SpectreRule [[-Title] <String>] [[-Alignment] <String>] [[-Color] <Color>] [[-LineColor] <Color>] [-PassThru] [<CommonParameters>]