PowerShell Logo Small


This is the built-in help made by Microsoft for the command 'Format-Custom', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.


Uses a customized view to format the output.


Format-Custom [[-Property] [<Object[]>]] [-Depth [<Int32>]] [-DisplayError] [-Expand {CoreOnly | EnumOnly | Both}] [-Force] [-GroupBy [<Object>]] [-InformationAction
{SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable [<System.String>]] [-InputObject [<PSObject>]] [-ShowError] [-View [<String>]]

Search powershellhelp.space


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.



Online Version: http://go.microsoft.com/fwlink/p/?linkid=293960




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

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

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.

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

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

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.