internal/Select-DefaultField.ps1

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
Function Select-DefaultField
{
    <#
     
    This command enables us to send full on objects to the pipeline without the user seeing it
     
    See it in action in Get-DbaSnapshot and Remove-DbaDatabaseSnapshot
     
    this is all from boe, thanks boe!
    https://learn-powershell.net/2013/08/03/quick-hits-set-the-default-property-display-in-powershell-on-custom-objects/
     
    #>

    
    [CmdletBinding()]
    param (
        [parameter(ValueFromPipeline = $true)]
        [pscustomobject]$InputObject,
        [string[]]$Property,
        [string[]]$ExcludeProperty
    )
    
    if ($InputObject -eq $null) { return }
    
    if ($ExcludeProperty)
    {
        $properties = ($InputObject.PsObject.Members | Where-Object MemberType -ne 'Method' | Where-Object { $_.Name -notin $ExcludeProperty }).Name
        $defaultset = New-Object System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet', [string[]]$properties)
    }
    else
    {
        # property needs to be string
        if ("$property" -like "* as *")
        {
            $newproperty = @()
            foreach ($p in $property)
            {
                if ($p -like "* as *")
                {
                    $old, $new = $p -isplit " as "
                    $inputobject | Add-Member -MemberType AliasProperty -Name $new -Value $old -Force
                    $newproperty += $new
                }
                else
                {
                    $newproperty += $p
                }
            }
            $property = $newproperty
        }
        
        $defaultset = New-Object System.Management.Automation.PSPropertySet('DefaultDisplayPropertySet', [string[]]$Property)
    }
    
    $standardmembers = [System.Management.Automation.PSMemberInfo[]]@($defaultset)
    $inputobject | Add-Member MemberSet PSStandardMembers $standardmembers -Force
    $inputobject
}