Skip to main content

Creating a Visual Separator with PowerShell

When I am delivering my PowerShell classes, I often like to provide a transcript of everything that I do on the screen.  This can often be a lot of information.  To help distinguish between different sections or content, I often just place an inline comment on the screen.  Well, I’m changing things a bit.  Below is my code for Show-Separator.  I use it to provide a visual separation from between content.  Here are some examples.

PS C:\> Show-Separator

-- 04/20/2014 08:41:47 ----------------------------------------------------

 

 

PS C:\> Show-Separator "Module 1 - Demo 3" -ColorSet Cyan

-- Module 1 - Demo 3 ------------------------------------------------------

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

 

<#

.SYNOPSIS

Places a separator on the host

 

.DESCRIPTION

Places a visual separator on the host screen.

 

.PARAMERATER ColorSet

Allows the user to change the coloring of the separator.  The default

color is "Green". Alternate colors are: "Blue", "Green", "Cyan", "Red",

"Magenta", "Yellow", "Gray", "White", "Black".

 

.PARAMTER String

The string of text to appeared in the separator.  The default string is

the current DateTime stamp.

 

.EXAMPLE

Show-Separator

 

-- 04/20/2014 08:11:39  ---------------------------------------------

 

Shows a visual separator on the screen in "Green" with the current

DateTime stamp.

 

.EXAMPLE

Show-Separator "Module 2 Examples" -ColorSet Cyan

 

-- Module 2 Examples ------------------------------------------------

 

Shows a visual separator on the screen in "Cyan" with the text

"Module 2 Examples"

#>

Function Show-Separator

{

    Param(

    [ValidateSet("Blue", "Green", "Cyan", "Red", "Magenta", "Yellow", "Gray", "White", "Black")]

    [String]

    $ColorSet = "Green",

   

   

    [parameter(Position=0)]

    [String]$String = "$(Get-Date)"   

    )

 

    # Add a space after the string.

    $String += " "

 

    # Truncate the string if it is to long.

    If (($String.length -6) -gt ((Get-host).UI.RawUI.BufferSize.Width))

    {

        $String = $String.Remove((Get-host).UI.RawUI.BufferSize.Width-5)

    }

 

 

    # Pad the right of the string with "-"

    $String = "-- $($String.PadRight(((Get-host).UI.RawUI.BufferSize.Width)-3,"-"))"

   

    # Set the colors to be used.

    Switch ($ColorSet)

    {

        "Blue" {$Hash = @{"Fore" = "Blue"; "Back" = "DarkBlue"}}

        "Green" {$Hash = @{"Fore" = "Green"; "Back" = "DarkGreen"}}

        "Cyan" {$Hash = @{"Fore" = "Cyan"; "Back" = "DarkCyan"}}

        "Red" {$Hash = @{"Fore" = "Red"; "Back" = "DarkRed"}}

        "Magenta" {$Hash = @{"Fore" = "Magenta"; "Back" = "DarkMagenta"}}

        "Yellow" {$Hash = @{"Fore" = "Yellow"; "Back" = "DarkYellow"}}

        "Gray" {$Hash = @{"Fore" = "Gray"; "Back" = "DarkGray"}}

        "Black" {$Hash = @{"Fore" = "White"; "Back" = "Black"}}

        "White" {$Hash = @{"Fore" = "Black"; "Back" = "White"}}

 

    } # End: Switch ($String)

 

    # Write the string to the host.

    Write-Host $String @Hash

} # End: Function Show-Separator

 

In lines 35-39 I’m defining the valid color sets for this function.  This allows for the user to TAB complete this parameter.

Line 43 will set the default value for the string as the current DateTime stamp.

Line 47 makes sure that a space will always be after the string.

Lines 50-53 will truncate the string provided by the user if it is to long.

Lines 61-73 create a splat for the color values.

Line 76 will write the string to the host.  Notice that the purpose of this function is not to place anything in the PowerShell pipeline.  It is only to provide a visual separation.

To help making this code even faster, I both added to an existing module that I have and I use an alias.  OK, I know, the hundreds of you who have sat through my PowerShell classes know that I do not advocate the usage of alias’.  My reasoning is that you may inadvertently place them in your code which restricts your code to only your client.  This particular function is not intended to be used in code so it is OK.

Alias code:

New-Alias –Name “SS” –Value “Show-Separator”

I place it in the following profile.

C:\Windows\User\UserName\Documents\WindowsPowerShell\profile.ps1

This way the alias is available to me in both the shell and the ISE.

Comments

Popular posts from this blog

Adding a Comment to a GPO with PowerShell

As I'm writing this article, I'm also writing a customization for a PowerShell course I'm teaching next week in Phoenix.  This customization deals with Group Policy and PowerShell.  For those of you who attend my classes may already know this, but I sit their and try to ask the questions to myself that others may ask as I present the material.  I finished up my customization a few hours ago and then I realized that I did not add in how to put a comment on a GPO.  This is a feature that many Group Policy Administrators may not be aware of. This past summer I attended a presentation at TechEd on Group Policy.  One organization in the crowd had over 5,000 Group Policies.  In an environment like that, the comment section can be priceless.  I always like to write in the comment section why I created the policy so I know its purpose next week after I've completed 50 other tasks and can't remember what I did 5 minutes ago. In the Group Policy module for PowerShell V3, th

Return duplicate values from a collection with PowerShell

If you have a collection of objects and you want to remove any duplicate items, it is fairly simple. # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   # Remove the duplicate values. $Set1 | Select-Object -Unique 1 2 3 4 5 6 7 What if you want only the duplicate values and nothing else? # Create a collection with duplicate values $Set1 = 1 , 1 , 2 , 2 , 3 , 4 , 5 , 6 , 7 , 1 , 2   #Create a second collection with duplicate values removed. $Set2 = $Set1 | Select-Object -Unique   # Return only the duplicate values. ( Compare-Object -ReferenceObject $Set2 -DifferenceObject $Set1 ) . InputObject | Select-Object – Unique 1 2 This works with objects as well as numbers.  The first command creates a collection with 2 duplicates of both 1 and 2.   The second command creates another collection with the duplicates filtered out.  The Compare-Object cmdlet will first find items that are diffe

How to list all the AD LDS instances on a server

AD LDS allows you to provide directory services to applications that are free of the confines of Active Directory.  To list all the AD LDS instances on a server, follow this procedure: Log into the server in question Open a command prompt. Type dsdbutil and press Enter Type List Instances and press Enter . You will receive a list of the instance name, both the LDAP and SSL port numbers, the location of the database, and its status.