Format-Custom

 

SYNOPSIS

Uses a customized view to format the output.

 

SYNTAX

Format-Custom [[-property] <Object[]>] [-inputObject <psobject>] [-view <string>] [-groupBy <Object>] [-force] [-expand <string>] [-displayError] [-showError] [-depth <int>] [<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-FormatDatacmdlet to add them to Windows PowerShell.

 

PARAMETERS

 

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

 

Required?	false
Position?	1
Default value
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.

 

Required?	false
Position?	named
Default value
Accept pipeline input?	true (ByValue)
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.

 

Required?	false
Position?	named
Default value
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.

 

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

 

-force <SwitchParameter>

Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions.

 

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.

 

Valid values are:

 

·          Enum (default): Displays the properties of the objects in the collection.

·          Core: 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

 

-displayError <SwitchParameter>

Displays errors at the command line.

 

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

 

-showError <SwitchParameter>

Sends errors through the pipeline.

 

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

 

-depth <int>

Specifies the number of columns in the display.

 

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

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

 

INPUT TYPE

Object

 

RETURN TYPE

Objects

 

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.

 

For more information, type "Get-Help Format-Custom -detailed". For technical information, type "Get-Help Format  -Custom -full".

 

When specifying multiple values for a parameter, use commas to separate the values. For example, "<parameter-name> <value1>, <value2>".

 

You can also refer to Format-Custom by its built-in alias, "fc". For more information, see About_Alias.

 

The Groupby parameter assumes that the objects are sorted. Before using Format-Custom to group the objects, use Sort-Objectto sort them.

 

EXAMPLE 1

 

 

This command formats information about the Start-Transcriptcmdlet 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.

 

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.

 

RELATED LINKS

Format-List

Format-Wide

Format-Table