是否可以在对象的属性上定义显示数据?

时间:2018-05-30 08:53:55

标签: powershell powershell-v5.0

使用Format-Table命令时,不是简单地列出属性名称,而是提供一个选项来提供包含属性名称(或某个表达式)的哈希表,以及有关该属性应该如何的元数据显示(例如alignwidth)。

$InputObject | Format-Table -Property @{Expression='Property1'; Width=100; Align="right";}, @{Expression='Property2'; Width=100; Align="left";}

有没有办法在输入对象的定义中提供此信息,例如以某种方式将此信息添加到PSStandardMembers成员集。

其他信息

我的具体用例是能够在Compare-ObjectProperties方法中定义默认宽度和对齐,以避免使用此函数的任何人每次都必须使用所有这些属性元数据调用Format-Table

function Compare-ObjectProperties { 
    [CmdletBinding()]
    Param(
        [Parameter(Mandatory = $true)]
        $InputObject
        ,
        [Parameter(Mandatory = $true)]
        $CompareObject
    ) 
    Process {
        $properties = @($InputObject, $CompareObject) | Get-Member -MemberType NoteProperty, Property | Select-Object -ExpandProperty Name | Sort-Object -Unique
        $properties | %{
            [pscustomobject][ordered]@{
                PropertyName = $_
                InputObject = $InputObject."$_"
                CompareObject = $CompareObject."$_"
            }
        }
    }
}
Clear-Host
$a = Get-ADUser someone
$b = Get-ADUser sometwo
Compare-ObjectProperties $a $b | 
    Where-Object {$_.InputObject -eq $_.CompareObject} | 
    Format-Table @{Expression='PropertyName'; Width=20;}, @{Expression='InputObject'; Width=100; Align="right";}, @{Expression='CompareObject'; Width=100; Align="left";}

1 个答案:

答案 0 :(得分:4)

PowerShell使用格式定义文件(Format.ps1xml)来定义对象的默认显示。

要在代码中实现此功能,请通过替换在

中包含返回对象中的类型
[pscustomobject][ordered]@{
    PropertyName = $_
    InputObject = $InputObject."$_"
    CompareObject = $CompareObject."$_"
}

使用:

$result = [pscustomobject][ordered]@{
    PropertyName = $_
    InputObject = $InputObject."$_"
    CompareObject = $CompareObject."$_"
}
$result.PSObject.TypeNames.Insert(0,'JohnLBevan.CompareObjectPropertiesResult')
$result

然后为给定类型创建一个定义文件/具有相应的属性名称&设置:

<?xml version="1.0" encoding="utf-8" ?>
<Configuration>
    <ViewDefinitions>
        <View>
            <Name>Default</Name>
            <ViewSelectedBy>
                <TypeName>JohnLBevan.CompareObjectPropertiesResult</TypeName>
            </ViewSelectedBy>
            <TableControl>
                <TableHeaders>
                    <TableColumnHeader>
                        <Width>20</Width>
                        <Alignment>left</Alignment>
                    </TableColumnHeader>
                    <TableColumnHeader>
                        <Width>90</Width>
                        <Alignment>right</Alignment>
                    </TableColumnHeader>
                    <TableColumnHeader>
                        <Width>90</Width>
                        <Alignment>left</Alignment>
                    </TableColumnHeader>
                </TableHeaders>
                <TableRowEntries>
                    <TableRowEntry>
                        <TableColumnItems>
                            <TableColumnItem>
                                <PropertyName>PropertyName</PropertyName>
                            </TableColumnItem>
                            <TableColumnItem>
                                <PropertyName>InputObject</PropertyName>
                            </TableColumnItem>
                            <TableColumnItem>
                                <PropertyName>CompareObject</PropertyName>
                            </TableColumnItem>
                        </TableColumnItems>
                    </TableRowEntry>
                </TableRowEntries>
            </TableControl>
        </View>
    </ViewDefinitions>
</Configuration>

将此文件另存为YourTypeName.format.ps1xml

最后,将此定义导入到您的脚本中:

Update-FormatData -AppendPath '.\JohnLBevan.CompareObjectPropertiesResult.Format.ps1xml'

现在,当您调用函数时,输出将由定义文件中的信息决定。