NAME
Format-Custom
SYNOPSIS
Uses a customized view to format the output.SYNTAX
Format-Custom [[-Property]
[-Force] [-GroupBy
DESCRIPTION
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 Windows PowerShell directory, or you can create your own views in new PS1XML files and
use the Update-FormatData cmdlet to add them to Windows PowerShell.
PARAMETERS
-Depth
Specifies the number of columns in the display. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-DisplayError [
Indicates that this cmdlet 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. The following shows an example of the results of adding the DisplayError parameter with an expression.`PS > Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError`
`DayOfWeek $_ / $null` `--------- ------------` `Wednesday #ERR`
Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false-Expand
Specifies that this cmdlet 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. The acceptable values for this parameter 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. Required? false Position? named Default value None Accept pipeline input? False Accept wildcard characters? false-Force [
Indicates that this cmdlet displays all of the error information. Use with the DisplayError or ShowError parameter. By default, when an error object is written to the error or display streams, only some of the error information is displayed. Required? false Position? named Default value False Accept pipeline input? False Accept wildcard characters? false] -GroupBy
Specifies that this cmdlet 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)
- Expression
or