Format-Wide

将对象格式设置为宽表,此表仅显示每个对象的一个属性。

语法

Format-Wide
      [[-Property] <Object>]
      [-AutoSize]
      [-Column <int>]
      [-GroupBy <Object>]
      [-View <string>]
       [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <string>]
      [-InputObject <psobject>] 
      [<CommonParameters>]

说明

Format-Wide cmdlet 将对象格式设置为宽表,此表仅显示每个对象的一个属性。 可以使用 Property 参数来确定显示哪个属性。

示例

示例 1:为当前目录中的文件名称设置格式

此命令将在屏幕上的三个列中显示当前目录中的文件的名称。

Get-ChildItem | Format-Wide -Column 3

Get-ChildItem cmdlet 将获取表示目录中的每个文件的对象。 管道运算符 (|) 将文件对象通过管道传递给 Format-Wide,后者将对它们进行格式设置以用于输出。 Column 参数指定列的数量。

示例 2:为注册表项的名称设置格式

此命令在 HKEY_CURRENT_USER\Software\Microsoft 项中显示注册表项的名称。

Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize

Get-ChildItem cmdlet 获取表示项的对象。 路径指定为 HKCU:,一个驱动器由 PowerShell Registry 提供程序公开,其后跟项路径。 管道运算符 (|) 将注册表项对象通过管道传递给 Format-Wide,后者将对它们进行格式设置以用于输出。 Property 参数指定属性名,而 AutoSize 参数调整列以提高可读性

示例 3:排查格式错误

下面的示例显示了使用表达式添加 DisplayError 或 ShowError 参数所产生的结果

PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError


#ERR

PS /> Get-Date | Format-Wide { $_ / $null } -ShowError


Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

参数

-AutoSize

基于数据的宽度来调整列的大小和数量。 默认情况下,列大小和数量由视图确定。 不能在同一命令中使用 AutoSize 和 Column 参数

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Column

指定显示中的列数。 不能在同一命令中使用 AutoSize 和 Column 参数

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

在命令行中显示错误。 此参数很少使用,但当你在 Format-Wide 命令中设置表达式的格式,并且这些表达式似乎无法正常工作时,此参数可用于帮助调试。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

设置集合对象以及集合中的对象的格式。 此参数旨在用于设置支持 System.Collections.ICollection 接口的对象的格式。 默认值是 EnumOnly

有效值为:

  • EnumOnly:显示集合中的对象的属性。
  • CoreOnly:显示集合对象的属性。
  • Both:显示集合对象的属性以及集合中的对象的属性。
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

指示此 cmdlet 覆盖阻止命令成功执行的限制,只要所做更改不会危及安全性。 例如,Force 将覆盖只读属性或创建目录以完成文件路径,但不会尝试更改文件权限。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

基于共享属性或值设置组中输出的格式。 请输入表达式或输出的属性。

GroupBy 参数的值可以是新计算属性。 计算属性可以是脚本块或哈希表。 有效的键值对包括:

  • Name(或 Label)- <string>
  • Expression - <string><script block>
  • FormatString - <string>

有关详细信息,请参阅 about_Calculated_Properties

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要设置格式的对象。 输入一个包含对象的变量,或键入可获取对象的命令或表达式。

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

指定显示屏中显示的对象属性。 允许使用通配符。

如果省略此参数,则屏幕上显示的属性取决于要显示的对象。 参数名 Property 为可选项。 不能在同一命令中使用 Property 和 View 参数

Property 参数的值可以是新的计算属性。 计算属性可以是脚本块或哈希表。 有效的键值对包括:

  • Expression - <string><script block>
  • FormatString - <string>

有关详细信息,请参阅 about_Calculated_Properties

Type:Object
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

通过管道发送错误。 此参数很少使用,但当你在 Format-Wide 命令中设置表达式的格式,并且这些表达式似乎无法正常工作时,此参数可用于帮助调试。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

指定替代表格格式或视图的名称。 不能在同一命令中使用 Property 和 View 参数

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

PSObject

你可以通过管道将任何对象传递给此 cmdlet。

输出

Microsoft.PowerShell.Commands.Internal.Format

此 cmdlet 返回表示表格的格式对象。

备注

PowerShell 包含 Format-Wide 的以下别名:

  • 所有平台:
    • fw

还可以通过其内置别名 fw 来引用 Format-Wide。 有关详细信息,请参阅 about_Aliases

GroupBy 参数假定对象已进行排序。 使用 Format-Custom 对对象进行分组之前,请使用 Sort-Object

使用 View 参数可以指定表的替代格式。 可以使用 PowerShell 目录中的 *.format.PS1XML 文件中定义的视图,或者可在新的 PS1XML 文件中创建自己的视图,并使用 Update-FormatData cmdlet 将它们包括在 PowerShell 中。

View 参数的可选视图必须使用表格式;否则,该命令将失败。 如果替代视图为列表,请使用 Format-List。 如果替代视图既不是列表也不是表格,请使用 Format-Custom