Cmdlet

Format-ConsoleList

Module ConsoleMonster

Inputs

System.Management.Automation.PSObject

Formats pipeline objects as record views (labelled values) and writes them to the host.

Syntax

Format-ConsoleList [-Culture <CultureInfo>] [-Depth <Int32>] [-GroupBy <Object>] [-InputObject <PSObject>] [-PassThru] [[-Property] <Object[]>] [-ShowEmpty] [-Title <Object>] [-Width <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Description

Formats pipeline objects as record views (labelled values) and writes them to the host.

Each object becomes a section titled by its key column (the first property, or one marked Key = $true) with the other properties as aligned label/value fields; empty values are hidden unless -ShowEmpty is given. Values go through presenters (statuses, sizes, durations, dates...), and complex values (nested objects, collections) expand as indented sections and nested tables down to -Depth levels. -Property works like Format-List, including calculated properties and the column option keys of Format-ConsoleTable. Redirected output is plain text.

Examples

Authored help example

EXAMPLE 1

Format-ConsoleList -Culture 'Value'

Parameters

-Culture CultureInfo optional: The culture for numbers and dates, for example en-US or pl-PL (labels stay English). Defaults to CONSOLEMONSTER_CULTURE, then the current culture, as PowerShell's own formatting does.
-Depth Int32 optional: How many levels of nested objects expand (default 1; 0 shows nested values as text).
-GroupBy Object optional: Groups records under headings by a property name or a scriptblock.
-InputObject PSObject optionalpipeline: True (ByValue): The objects to show (pipeline input).
-PassThru SwitchParameter optional: Also writes the input objects to the pipeline.
-Property Object[] optionalposition: 0: Properties (names, wildcards, calculated properties and column option hashtables).
-ShowEmpty SwitchParameter optional: Shows empty values (hidden by default).
-Title Object optional: A title on the summary line (markup).
-Width Int32 optional: Lays the records out for this width instead of the terminal's.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.