Compartir vía

Format-Wide

Módulo:
Microsoft.PowerShell.Utility Module

Da formato a los objetos como una tabla ancha que muestra solo una propiedad de cada objeto.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

El cmdlet Format-Wide da formato a los objetos como una tabla ancha que muestra solo una propiedad de cada objeto. Puede usar el parámetro Property para determinar qué propiedad se muestra.

Ejemplos

Ejemplo 1: Formato de nombres de archivos en el directorio actual

Este comando muestra los nombres de los archivos en el directorio actual en tres columnas a través de la pantalla.

Get-ChildItem | Format-Wide -Column 3

El cmdlet Get-ChildItem obtiene objetos que representan cada archivo del directorio. El operador de canalización (|) pasa los objetos de archivo a través de la canalización a Format-Wide, que les da formato para la salida. El parámetro Columna especifica el número de columnas.

Ejemplo 2: Formato de nombres de claves del Registro

Este comando muestra los nombres de las claves del Registro en la clave HKEY_CURRENT_USER\Software\Microsoft.

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

El cmdlet Get-ChildItem obtiene objetos que representan las claves. La ruta de acceso se especifica como HKCU:, que es una de las unidades expuestas por el proveedor del Registro de PowerShell, seguido de la ruta de la clave. El operador de canalización (|) pasa los objetos de clave del Registro a través de la canalización a Format-Wide, que les da formato para la salida. El parámetro Property especifica el nombre de la propiedad y el parámetro AutoSize ajusta las columnas para mejorar la legibilidad.

Ejemplo 3: Solución de errores de formato

En los ejemplos siguientes se muestran los resultados de agregar los parámetros DisplayError o ShowError con una expresión.

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

Parámetros

-AutoSize

Ajusta el tamaño de columna y el número de columnas en función del ancho de los datos. De forma predeterminada, la vista determina el tamaño y el número de columnas. No se pueden usar los parámetros AutoSize y Column en el mismo comando.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Column

Especifica el número de columnas de la pantalla. No se pueden usar los parámetros AutoSize y Column en el mismo comando.

Propiedades del parámetro

Tipo:Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-DisplayError

Muestra errores en la línea de comandos. Este parámetro rara vez se usa, pero se puede usar como ayuda de depuración cuando se dan formato a expresiones en un comando Format-Wide y las expresiones no parecen funcionar.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Expand

Da formato al objeto de colección, así como a los objetos de la colección. Este parámetro está diseñado para dar formato a los objetos que admiten la interfaz System.Collections.ICollection. El valor predeterminado es EnumOnly.

Los valores válidos son:

  • EnumOnly: muestra las propiedades de los objetos de la colección.
  • CoreOnly: muestra las propiedades del objeto de colección.
  • Both: muestra las propiedades del objeto de colección y las propiedades de los objetos de la colección.

Propiedades del parámetro

Tipo:String
Valor predeterminado:EnumOnly
Valores aceptados:CoreOnly, EnumOnly, Both
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Force

Indica que este cmdlet invalida las restricciones que impiden que el comando se realice correctamente, solo para que los cambios no pongan en peligro la seguridad. Por ejemplo, Force invalidará el atributo de solo lectura o creará directorios para completar una ruta de acceso de archivo, pero no intentará cambiar los permisos de archivo.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-GroupBy

Da formato a la salida en grupos en función de una propiedad o valor compartidos. Escriba una expresión o una propiedad de la salida. El parámetro GroupBy espera que los objetos estén ordenados. Use el cmdlet Sort-Object antes de usar Format-Wide para agrupar los objetos.

El valor del parámetro GroupBy puede ser una nueva propiedad calculada. La propiedad calculada puede ser un bloque de script o una tabla hash. Los pares clave-valor válidos son:

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

Para obtener más información, consulte about_Calculated_Properties.

Propiedades del parámetro

Tipo:Object
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-InputObject

Especifica los objetos a los que se va a dar formato. Escriba una variable que contenga los objetos, o escriba un comando o expresión que obtenga los objetos.

Propiedades del parámetro

Tipo:PSObject
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Property

Especifica la propiedad de objeto que aparece en la pantalla. Se permiten los caracteres comodín.

Si omite este parámetro, las propiedades que aparecen en la pantalla dependen del objeto que se muestra. El nombre del parámetro Property es opcional. No se pueden usar los parámetros Property y View en un solo comando.

El valor del parámetro Property puede ser una nueva propiedad calculada. La propiedad calculada puede ser un bloque de script o una tabla hash. Los pares clave-valor válidos son:

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

Para obtener más información, consulte about_Calculated_Properties.

Propiedades del parámetro

Tipo:Object
Valor predeterminado:None
Admite caracteres comodín:True
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ShowError

Envía errores a través de la canalización. Este parámetro rara vez se usa, pero se puede usar como ayuda de depuración cuando se dan formato a expresiones en un comando Format-Wide y las expresiones no parecen funcionar.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-View

Especifica el nombre de un formato o vista de tabla alternativo. No se pueden usar los parámetros Property y View en un solo comando.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

PSObject

Puede canalizar cualquier objeto a este cmdlet.

Salidas

Microsoft.PowerShell.Commands.Internal.Format

Este cmdlet devuelve objetos de formato que representan la tabla.

Notas

PowerShell incluye los siguientes alias para Format-Wide:

  • Todas las plataformas:
    • fw

El parámetro View permite especificar un formato alternativo para la tabla. Puede usar las vistas definidas en los archivos de *.format.ps1xml en el directorio de PowerShell o puede crear sus propias vistas en los nuevos archivos PS1XML y usar el cmdlet Update-FormatData para incluirlos en PowerShell.

La vista alternativa del parámetro View debe usar el formato de tabla; si no lo hace, se produce un error en el comando. Si la vista alternativa es una lista, use Format-List. Si la vista alternativa no es una lista ni una tabla, use Format-Custom.