Partager via

Format-Wide

Module:
Microsoft.PowerShell.Utility Module

Met en forme des objets sous la forme d’une table large qui affiche une seule propriété de chaque objet.

Syntaxe

Default (Par défaut) 

Format-Wide
    [[-Property] <Object>]
    [-AutoSize]
    [-Column <int>]
    [-GroupBy <Object>]
    [-View <string>]
    [-ShowError]
    [-DisplayError]
    [-Force]
    [-Expand <string>]
    [-InputObject <psobject>]
    [<CommonParameters>]

Description

L’applet de commande Format-Wide met en forme des objets sous la forme d’une table large qui n’affiche qu’une seule propriété de chaque objet. Vous pouvez utiliser le paramètre Property pour déterminer quelle propriété s’affiche.

Exemples

Exemple 1 : Mettre en forme les noms de fichiers dans le répertoire actif

Cette commande affiche les noms des fichiers dans le répertoire actif dans trois colonnes sur l’écran.

Get-ChildItem | Format-Wide -Column 3

L’applet de commande Get-ChildItem obtient des objets représentant chaque fichier dans le répertoire. L’opérateur de pipeline (|) transmet les objets de fichier via le pipeline à Format-Wide, qui les met en forme pour la sortie. Le paramètre Column spécifie le nombre de colonnes.

Exemple 2 : Mettre en forme les noms des clés de Registre

Cette commande affiche les noms des clés de Registre dans la clé HKEY_CURRENT_USER\Software\Microsoft.

Get-ChildItem HKCU:\software\Microsoft | Format-Wide -Property PSChildName -AutoSize

L’applet de commande Get-ChildItem obtient des objets représentant les clés. Le chemin d'accès est spécifié comme HKCU:, l'un des lecteurs exposés par le fournisseur de Registre PowerShell, suivi du chemin d'accès à la clé. L’opérateur de pipeline (|) transmet les objets de clé de Registre via le pipeline à Format-Wide, qui les met en forme pour la sortie. Le paramètre Property spécifie le nom de la propriété, et le paramètre AutoSize ajuste les colonnes à des fins de lisibilité.

Exemple 3 : Résolution des erreurs de format

Les exemples suivants montrent les résultats de l’ajout des paramètres DisplayError ou ShowError avec une expression.

PS /> Get-Date | Format-Wide { $_ / $null } -DisplayError


#ERR

PS /> Get-Date | Format-Wide { $_ / $null } -ShowError


Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:18:01 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Paramètres

-AutoSize

Ajuste la taille et le nombre de colonnes en fonction de la largeur des données. Par défaut, la taille et le nombre de colonnes sont déterminés par la vue. Vous ne pouvez pas utiliser les paramètres AutoSize et Column dans la même commande.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Column

Spécifie le nombre de colonnes dans l’affichage. Vous ne pouvez pas utiliser les paramètres AutoSize et Column dans la même commande.

Propriétés du paramètre

Type:Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DisplayError

Affiche les erreurs sur la ligne de commande. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une commande Format-Wide et que les expressions ne semblent pas fonctionner.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Expand

Met en forme l’objet de collection, ainsi que les objets de la collection. Ce paramètre est conçu pour mettre en forme des objets qui prennent en charge l’interface System.Collections.ICollection. La valeur par défaut est EnumOnly.

Les valeurs valides sont les suivantes :

  • EnumOnly: affiche les propriétés des objets de la collection.
  • CoreOnly: affiche les propriétés de l’objet de collection.
  • Both: affiche les propriétés de l’objet de collection et les propriétés des objets de la collection.

Propriétés du paramètre

Type:String
Valeur par défaut:EnumOnly
Valeurs acceptées:CoreOnly, EnumOnly, Both
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

Indique que cette applet de commande remplace les restrictions qui empêchent la commande de réussir, de sorte que les modifications ne compromettent pas la sécurité. Par exemple, Force remplace l’attribut en lecture seule ou crée des répertoires pour compléter un chemin de fichier, mais il ne tente pas de modifier les autorisations de fichier.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-GroupBy

Met en forme la sortie dans les groupes en fonction d’une propriété ou d’une valeur partagée. Entrez une expression ou une propriété de la sortie. Le paramètre GroupBy s’attend à ce que les objets soient triés. Utilisez l’applet de commande Sort-Object avant d’utiliser Format-Wide pour regrouper les objets.

La valeur du paramètre GroupBy peut être une nouvelle propriété calculée. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

  • Name (ou Label) - <string>
  • Expression - <string> ou <script block>
  • FormatString - <string>

Pour plus d'informations, voir about_Calculated_Properties.

Propriétés du paramètre

Type:Object
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-InputObject

Spécifie les objets à mettre en forme. Entrez une variable qui contient les objets, ou tapez une commande ou une expression qui obtient les objets.

Propriétés du paramètre

Type:PSObject
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Property

Spécifie la propriété d’objet qui apparaît dans l’affichage. Les caractères génériques sont autorisés.

Si vous omettez ce paramètre, les propriétés qui apparaissent dans l’affichage dépendent de l’objet affiché. Le nom du paramètre Property est facultatif. Vous ne pouvez pas utiliser les paramètres Property et View dans la même commande.

La valeur du paramètre Property peut être une nouvelle propriété calculée. La propriété calculée peut être un bloc de script ou une table de hachage. Les paires clé-valeur valides sont les suivantes :

  • Expression - <string> ou <script block>
  • FormatString - <string>

Pour plus d'informations, voir about_Calculated_Properties.

Propriétés du paramètre

Type:Object
Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ShowError

Envoie les erreurs via le pipeline. Ce paramètre est rarement utilisé, mais peut être utilisé comme aide de débogage lorsque vous mettez en forme des expressions dans une commande Format-Wide et que les expressions ne semblent pas fonctionner.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-View

Spécifie le nom d’un autre format de tableau ou vue. Vous ne pouvez pas utiliser les paramètres Property et View dans la même commande.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

PSObject

Vous pouvez diriger n’importe quel objet vers cette applet de commande.

Sorties

Microsoft.PowerShell.Commands.Internal.Format

Cette applet de commande retourne des objets de format qui représentent le tableau.

Notes

PowerShell inclut les alias suivants pour Format-Wide:

  • Toutes les plateformes :
    • fw

Le paramètre View vous permet de spécifier un autre format pour le tableau. Vous pouvez utiliser les vues définies dans les fichiers *.format.ps1xml dans le répertoire PowerShell ou créer vos propres vues dans de nouveaux fichiers PS1XML et utiliser l’applet de commande Update-FormatData pour les inclure dans PowerShell.

L’autre affichage du paramètre View doit utiliser le format de table ; si ce n’est pas le cas, la commande échoue. Si l’affichage de remplacement est une liste, utilisez Format-List. Si l’affichage de remplacement n’est ni une liste ni une table, utilisez Format-Custom.