CmdID / PowerShell / Cmdlets / Format
Format-Custom
Uses a customized view to format the output. PowerShell reference
From the PowerShell reference
9 parameters
Alias fc
What it does
Uses a customized view to format the output. 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 PowerShell, or you can create your own views in a new format.ps1xml file and use the Update-FormatData cmdlet to add them to PowerShell.
Format-Custom [[-Property] <Object[]>] [-Depth <Int32>] [-GroupBy <Object>] [-View <String>] [-ShowError] [-DisplayError] [-Force] [-Expand <String>] [-InputObject <PSObject>] [<CommonParameters>]Format output with a custom view
Get-Command Start-Transcript | Format-Custom -View MyViewIdentifyFormat output with the default view
Get-Process Winlogon | Format-CustomIdentifyTroubleshooting format errors
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 : PSPropertyExpressionErrorIdentifyIts page in the reference: Format-Custom.
Parameters
-DepthSpecifies the number of columns in the display.-DisplayErrorDisplays 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.-ExpandFormats the collection object, as well as the objects in the collection. This parameter is designed to format objects that support the System.Collections.ICollection 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 objects in the collection.-ForceDirects 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.-GroupByFormats the output in groups based on a shared property or value. Enter an expression or a property of the output. The GroupBy parameter expects that the objects are sorted. Use the Sort-Object cmdlet before using Format-Custom to group the objects.
The value of the GroupBy parameter can be a new calculated property. The calculated property can be a scriptblock or a hashtable. Valid key-value pairs are:
- Name (or Label) - <string>
- Expression - <string> or <scriptblock>
- FormatString - <string>
For more information, see about_Calculated_Properties.-InputObjectSpecifies the objects to be formatted. Enter a variable that contains the objects or type a command or expression that gets the objects.-PropertySpecifies 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. The calculated property can be a scriptblock or a hash table. Valid key-value pairs are:
- Expression - <string> or <scriptblock>
- Depth - <int32>
For more information, see about_Calculated_Properties.-ShowErrorSends 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.-ViewSpecifies 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.