powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Format-Custom



NAME
Format-Custom

SYNOPSIS
Uses a customized view to format the output.

SYNTAX
Format-Custom [[-Property] ] [-Depth ] [-DisplayError] [-Expand ] [-Force] [-GroupBy >] [-InputObject ] [-ShowError] [-View ] []


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-Forma
tData cmdlet to add them to Windows PowerShell.


PARAMETERS
-Depth
Specifies the number of columns in the display.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-DisplayError []
Displays errors at the command line.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Expand
Formats the collection object, as well as the objects in the collection. This parameter is designed to format o
bjects 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? 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.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-GroupBy
Formats the output in groups based on a shared property or value. Enter an expression or a property of the outp
ut.

The value of the GroupBy parameter can be a new calculated property. To create a calculated, property, use a ha
sh table. Valid keys are:

-- Name (or Label)
-- Expression or