Format-Wide
Formata objetos como uma tabela ampla que exibe apenas uma propriedade de cada objeto.
Sintaxe
Default (Default)
Format-Wide
[[-Property] <Object>]
[-AutoSize]
[-Column <int>]
[-GroupBy <Object>]
[-View <string>]
[-ShowError]
[-DisplayError]
[-Force]
[-Expand <string>]
[-InputObject <psobject>]
[<CommonParameters>]
Description
O cmdlet Format-Wide formata objetos como uma tabela ampla que exibe apenas uma propriedade de cada objeto. Você pode usar o parâmetro Property para determinar qual propriedade é exibida.
Exemplos
Exemplo 1: formatar nomes de arquivos no diretório atual
Esse comando exibe os nomes dos arquivos no diretório atual em três colunas na tela.
Get-ChildItem | Format-Wide -Column 3
O cmdlet Get-ChildItem obtém objetos que representam cada arquivo no diretório. O operador de pipeline (|) passa os objetos de arquivo por meio do pipeline para Format-Wide, que os formata para saída. O parâmetro coluna especifica o número de colunas.
Exemplo 2: formatar nomes de chaves do Registro
Esse comando exibe os nomes das chaves do Registro na chave HKEY_CURRENT_USER\Software\Microsoft.
Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize
O cmdlet Get-ChildItem obtém objetos que representam as chaves. O caminho é especificado como HKCU:, uma das unidades expostas pelo provedor Windows PowerShell Registry, seguido pelo caminho da chave. O operador de pipeline (|) passa os objetos de chave de registro por meio do pipeline para Format-Wide, que os formata para saída. O parâmetro Property especifica o nome da propriedade e o parâmetro AutoSize ajusta as colunas para legibilidade.
Exemplo 3: Solução de problemas de erros de formato
Os exemplos a seguir mostram os resultados da adição dos parâmetros DisplayError ou ShowError a uma expressão.
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 o tamanho da coluna e o número de colunas com base na largura dos dados. Por padrão, o tamanho e o número da coluna são determinados pela exibição. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Column
Especifica o número de colunas na exibição. Você não pode usar os parâmetros AutoSize e Column no mesmo comando.
Propriedades do parâmetro
| Tipo: | Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-DisplayError
Exibe erros na linha de comando. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um comando Format-Wide e as expressões não parecem estar funcionando.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Expand
Formata o objeto de coleção, bem como os objetos na coleção. Esse parâmetro foi projetado para formatar objetos que dão suporte à interface System.Collections.ICollection. O valor padrão é EnumOnly.
Os valores válidos são:
-
EnumOnly: exibe as propriedades dos objetos na coleção. -
CoreOnly: exibe as propriedades do objeto de coleção. -
Both: exibe as propriedades do objeto de coleção e as propriedades dos objetos na coleção.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | EnumOnly |
| Valores aceitos: | CoreOnly, EnumOnly, Both |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Indica que esse cmdlet substitui restrições que impedem que o comando seja bem-sucedido, apenas para que as alterações não comprometam a segurança. Por exemplo, o Force substituirá o atributo somente leitura ou criar diretórios para concluir um caminho de arquivo, mas não tentará alterar permissões de arquivo.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-GroupBy
Formata a saída em grupos com base em uma propriedade ou valor compartilhado. Insira uma expressão ou uma propriedade da saída.
O valor do parâmetro GroupBy pode ser uma nova propriedade calculada. A propriedade calculada pode ser um bloco de script ou uma tabela de hash. Pares chave-valor válidos são:
-
Name(ouLabel) –<string> -
Expression-<string>ou<script block> FormatString-<string>
Para obter mais informações, consulte about_Calculated_Properties.
Propriedades do parâmetro
| Tipo: | Object |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-InputObject
Especifica os objetos a serem formatados. Insira uma variável que contenha os objetos ou digite um comando ou expressão que obtém os objetos.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Property
Especifica a propriedade do objeto que aparece na exibição. Caracteres curinga são permitidos.
Se você omitir esse parâmetro, as propriedades que aparecem na exibição dependerão do objeto que está sendo exibido. O nome do parâmetro Property é opcional. Você não pode usar os parâmetros Property e View no mesmo comando.
O valor do parâmetro da Propriedade
-
Expression-<string>ou<script block> FormatString-<string>
Para obter mais informações, consulte about_Calculated_Properties.
Propriedades do parâmetro
| Tipo: | Object |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 0 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ShowError
Envia erros por meio do pipeline. Esse parâmetro raramente é usado, mas pode ser usado como um auxílio de depuração quando você está formatando expressões em um comando Format-Wide e as expressões não parecem estar funcionando.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-View
Especifica o nome de um formato ou exibição de tabela alternativo. Você não pode usar os parâmetros Property e View no mesmo comando.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
PSObject
Você pode redirecionar qualquer objeto para este cmdlet.
Saídas
Microsoft.PowerShell.Commands.Internal.Format
Esse cmdlet retorna objetos de formato que representam a tabela.
Observações
O PowerShell inclui os seguintes aliases para Format-Wide:
- Todas as plataformas:
fw
O parâmetro GroupBy pressupõe que os objetos sejam classificados. Use Sort-Object antes de usar Format-Custom para agrupar os objetos.
O parâmetro View permite que você especifique um formato alternativo para a tabela. Você pode usar as exibições definidas nos arquivos *.format.PS1XML no diretório do PowerShell ou criar suas próprias exibições em novos arquivos PS1XML e usar o cmdlet Update-FormatData para incluí-los no PowerShell.
O modo de exibição alternativo do parâmetro View deve usar o formato de tabela; se não o fizer, o comando falhará. Se a exibição alternativa for uma lista, use Format-List. Se o modo de exibição alternativo não for uma lista nem uma tabela, use Format-Custom.