Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Format-Custom

Format-Custom

microsoft.powershell.commands.utility.dll

Synopsis

Uses a customized view to format the output.

Syntax

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

Detailed 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 <Int32>

Specifies the number of columns in the display.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-DisplayError <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-Expand <String>

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.

Aliases

None

Required?

false

Position

named

Default value

EnumOnly

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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.

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-GroupBy <Object>

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>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the objects to be formatted. Enter a variable that contains the objects or type a command or expression that gets the objects.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Property <Object[]>

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>

Aliases

None

Required?

false

Position

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-ShowError <SwitchParameter>

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. The following shows an example of the results of adding the ShowError parameter with an expression.

PS > Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError DayOfWeek $_ / $null --------- ------------ Wednesday

Failed to evaluate expression " $_ / $null ". + CategoryInfo : InvalidArgument: (10/30/2013 2:28:07 PM:PSObject) [], RuntimeException + FullyQualifiedErrorId : mshExpressionError

Aliases

None

Required?

false

Position

named

Default value

False

Accept pipeline input?

false

Accept wildcard characters?

false

-View <String>

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.

Aliases

None

Required?

false

Position

named

Default value

Default custom view

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

System.Management.Automation.PSObject

Return Type

Microsoft.PowerShell.Commands.Internal.Format

Notes

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.

Examples

-------------------------- EXAMPLE 1 --------------------------

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 Windows PowerShell.

PS C:\>get-command start-transcript | format-custom -view MyView

-------------------------- EXAMPLE 2 --------------------------

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.

PS C:\>get-process Winlogon | format-custom

Online Version