Format-Custom
Uses a customized view to format the output.
语法
Default (默认值)
Format-Custom
[[-Property] <Object[]>]
[-Depth <Int32>]
[-GroupBy <Object>]
[-View <String>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <String>]
[-InputObject <PSObject>]
[<CommonParameters>]
说明
The Format-Custom
cmdlet formats the output of a command as defined in an alternate view.
Format-Custom
is designed to display views that are not just tables or just lists. You can use
the views defined in the *format.PS1XML files in the PowerShell directory, or you can create your
own views in new PS1XML files and use the Update-FormatData cmdlet to add them to PowerShell.
示例
Example 1: Format output with a custom view
Get-Command Start-Transcript | Format-Custom -View MyView
This command formats information about the Start-Transcript
cmdlet in the format defined by the
MyView view, a custom view created by the user. To run this command successfully, you must first
create a new PS1XML file, define the MyView view, and then use the Update-FormatData
command to
add the PS1XML file to PowerShell.
Example 2: Format output with the default view
Get-Process Winlogon | Format-Custom
This command formats information about the Winlogon process in an alternate customized view.
Because the command does not use the View parameter, Format-Custom
uses a default custom view
to format the data.
Example 3: Troubleshooting format errors
The following examples show of the results of adding the DisplayError or ShowError parameters with an expression.
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError
class DateTime
{
DayOfWeek = Friday
$_ / $null = #ERR
}
PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError
class DateTime
{
DayOfWeek = Friday
$_ / $null =
}
Failed to evaluate expression " $_ / $null ".
+ CategoryInfo : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError
参数
-Depth
Specifies the number of columns in the display.
参数属性
类型: | Int32 |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-DisplayError
Displays errors at the command line. This parameter is rarely used, but can be used as a debugging
aid when you are formatting expressions in a Format-Custom
command, and the expressions do not
appear to be working.
参数属性
类型: | SwitchParameter |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Expand
Formats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the ICollection (System.Collections) interface. The default value is EnumOnly.
Valid values are:
- EnumOnly: Displays the properties of the objects in the collection.
- CoreOnly: Displays the properties of the collection object.
- Both: Displays the properties of the collection object and the properties of objects in the collection.
参数属性
类型: | String |
默认值: | EnumOnly |
接受的值: | CoreOnly, EnumOnly, Both |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Force
Directs the cmdlet to display all of the error information. Use with the DisplayError or ShowError parameters. By default, when an error object is written to the error or display streams, only some of the error information is displayed.
参数属性
类型: | SwitchParameter |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-GroupBy
Formats the output in groups based on a shared property or value. Enter an expression or a property of the output.
The value of the GroupBy parameter can be a new calculated property. To create a calculated, property, use a hash table. Valid keys are:
- Name (or Label) <string>
- Expression <string> or <script block>
- FormatString <string>
参数属性
类型: | Object |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-InputObject
Specifies the objects to be formatted. Enter a variable that contains the objects or type a command or expression that gets the objects.
参数属性
类型: | PSObject |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | True |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Property
Specifies the object properties that appear in the display and the order in which they appear. Wildcards are permitted.
If you omit this parameter, the properties that appear in the display depend on the object being displayed. The parameter name ("Property") is optional. You cannot use the Property and View parameters in the same command.
The value of the Property parameter can be a new calculated property. To create a calculated property, use a hash table. Valid keys are:
- Expression <string> or <script block>
- Depth <int32>
参数属性
类型: | Object[] |
默认值: | None |
支持通配符: | True |
不显示: | False |
参数集
(All)
Position: | 0 |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-ShowError
Sends errors through the pipeline. This parameter is rarely used, but can be used as a debugging
aid when you are formatting expressions in a Format-Custom
command, and the expressions do not
appear to be working.
参数属性
类型: | SwitchParameter |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-View
Specifies the name of an alternate format or "view." If you omit this parameter, Format-Custom
uses a default custom view. You cannot use the Property and View parameters in the same
command.
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
输入
PSObject
You can pipe any object to Format-Custom.
输出
Microsoft.PowerShell.Commands.Internal.Format
Format-Custom
returns the format objects that represent the display.
备注
Format-Custom
is designed to display views that are not just tables or just lists. To display an
alternate table view, use Format-Table
. To display an alternate list view, use Format-List
.
You can also refer to Format-Custom
by its built-in alias, "fc". For more information, see
about_Aliases.
The GroupBy parameter assumes that the objects are sorted. Before using Format-Custom
to
group the objects, use Sort-Object
to sort them.